[PATCH v2 00/12] Add support for extension boards detection and DT overlays application

This series of patches aims at proposing a generic U-Boot mechanism to detect extension boards connected to the HW platform, and apply the appropriate Device Tree overlays depending on the detected extension boards.
Indeed, numerous popular platforms, such as the BeagleBone or the RaspberryPi, feature some kind of extension board mechanism. These extension boards are often discoverable through some kind of EEPROM (connected on I2C, 1-wire, etc.) and require Device Tree overlays to be applied at the U-Boot level to provide a complete HW description to the Linux kernel. However, currently this logic is usually implemented ad-hoc in downstream forks of U-Boot.
This series proposes to bring a HW-agnostic and generic solution to this problem to upstream U-Boot. The series shows that it is generic enough by implementing its usage for 2 different families of HW platforms and expansion boards:
- The BeagleBone Black and BeagleBone AI, that use extension boards where the EEPROM describing the extension boards is connected over I2C.
- The CHIP, that uses extension boards where the EEPROM describing the extension boards is connected over 1-wire.
The patch series implements a new command called "extension", with two sub-commands:
- "extension scan" to detect available extension boards
- "extension list" will simply list the detected extension boards
- "extension apply" will allow to apply the Device Tree overlays corresponding to one extension board or to all expansion boards
Note that the name "extension" has been chosen to not refer to any particular board-specific terminology for extension boards ("cape" for BeagleBone, "DIP" for CHIP, "hat" for RaspberryPi, etc.). However, we welcome suggestions of other names and are definitely willing to use a different naming.
The "extension apply" command requires two environment variables to be defined so that it knows how to apply DT overlays. This is described in more details in PATCH 1.
This generic code requires board-specific code for the detection and enumeration of extension boards. This is simply implemented in the form of a board-specific extension_board_scan() function, which fills in a list of detected extension boards.
In detail:
- PATCH 1 move fdt_valid function to fdt_support file - PATCH 2 implements the generic command and logic - PATCH 3 implements the python test for the "extension" command - PATCH 4 implements the board-specific code for the BeagleBone platforms - PATCH 5 enables the mechanism for the BeagleBone AI - PATCH 6 to 8 review the detection mechanism of one-wire devices - PATCH 9 an 10 enable the mechanism for the CHIP - PATCH 10 and 11 enable the mechanism for the BeagleBone Black
Thanks in advance for your review and feedback
Change since v1: - remove the one wire devicetree description of the CHIP board - rewrite the detection of w1 to makes it automatic and not devicetree dependant - replace Kconfig CHIP board target by Kconfig CHIP_DIP_SCAN simple option - rewrite doc to rST syntax - make few syntax update
Kory Maincent (12): fdt_support: move fdt_valid from cmd_fdt.c to fdt_support.c cmd: add support for a new "extension" command pytest: add sandbox test for "extension" command ti/common: add support for extension_scan_board function am57xx: add support for cape detect functionality w1: replace dt detection by automatic detection w1-eeprom: remove sandbox eeprom driver sandbox: remove w1-eeprom declaration and document arm: mach-sunxi: add configuration for the CHIP to enable w1 sun5i: add support for DIP detection to CHIP board arm: am335x: add support for i2c2 bus am335x: add support for cape detect functionality
arch/Kconfig | 2 + arch/arm/mach-omap2/am33xx/Kconfig | 1 + arch/arm/mach-omap2/am33xx/clock_am33xx.c | 1 + arch/arm/mach-omap2/omap5/Kconfig | 1 + arch/arm/mach-sunxi/Kconfig | 9 + arch/sandbox/dts/Makefile | 1 + arch/sandbox/dts/overlay0.dts | 9 + arch/sandbox/dts/overlay1.dts | 9 + arch/sandbox/dts/sandbox.dtsi | 18 -- board/sandbox/sandbox.c | 23 +++ board/sunxi/Makefile | 1 + board/sunxi/chip.c | 104 +++++++++++ board/ti/am335x/board.c | 3 + board/ti/am335x/board.h | 1 + board/ti/am335x/mux.c | 15 ++ board/ti/am57xx/board.c | 1 + board/ti/common/Kconfig | 6 + board/ti/common/Makefile | 1 + board/ti/common/cape_detect.c | 96 ++++++++++ board/ti/common/cape_detect.h | 28 +++ cmd/Kconfig | 12 ++ cmd/Makefile | 1 + cmd/extension_board.c | 167 ++++++++++++++++++ cmd/fdt.c | 49 ----- common/fdt_support.c | 46 +++++ configs/CHIP_defconfig | 1 + .../w1-eeprom/eep_sandbox.txt | 34 ---- doc/usage/extension.rst | 111 ++++++++++++ drivers/w1-eeprom/Makefile | 2 - drivers/w1-eeprom/ds24xxx.c | 20 +-- drivers/w1-eeprom/ds2502.c | 18 +- drivers/w1-eeprom/eep_sandbox.c | 61 ------- drivers/w1-eeprom/w1-eeprom-uclass.c | 45 +++-- drivers/w1/w1-uclass.c | 2 +- include/extension_board.h | 31 ++++ include/fdt_support.h | 2 + include/w1-eeprom.h | 2 +- include/w1.h | 17 ++ test/py/tests/test_extension.py | 52 ++++++ 39 files changed, 785 insertions(+), 218 deletions(-) create mode 100644 arch/sandbox/dts/overlay0.dts create mode 100644 arch/sandbox/dts/overlay1.dts create mode 100644 board/sunxi/chip.c create mode 100644 board/ti/common/cape_detect.c create mode 100644 board/ti/common/cape_detect.h create mode 100644 cmd/extension_board.c delete mode 100644 doc/device-tree-bindings/w1-eeprom/eep_sandbox.txt create mode 100644 doc/usage/extension.rst delete mode 100644 drivers/w1-eeprom/eep_sandbox.c create mode 100644 include/extension_board.h create mode 100644 test/py/tests/test_extension.py

Move the fdt_valid function to fdt_support. This changes allow to be able to test the validity of a devicetree in other c files.
Update code syntax.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com Reviewed-by: Tom Rini trini@konsulko.com --- cmd/fdt.c | 49 ------------------------------------------- common/fdt_support.c | 46 ++++++++++++++++++++++++++++++++++++++++ include/fdt_support.h | 2 ++ 3 files changed, 48 insertions(+), 49 deletions(-)
diff --git a/cmd/fdt.c b/cmd/fdt.c index 89ab572d8d..f1e2fc2fd8 100644 --- a/cmd/fdt.c +++ b/cmd/fdt.c @@ -27,7 +27,6 @@ */ DECLARE_GLOBAL_DATA_PTR;
-static int fdt_valid(struct fdt_header **blobp); static int fdt_parse_prop(char *const*newval, int count, char *data, int *len); static int fdt_print(const char *pathp, char *prop, int depth); static int is_printable_string(const void *data, int len); @@ -732,54 +731,6 @@ static int do_fdt(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
/****************************************************************************/
-/** - * fdt_valid() - Check if an FDT is valid. If not, change it to NULL - * - * @blobp: Pointer to FDT pointer - * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL) - */ -static int fdt_valid(struct fdt_header **blobp) -{ - const void *blob = *blobp; - int err; - - if (blob == NULL) { - printf ("The address of the fdt is invalid (NULL).\n"); - return 0; - } - - err = fdt_check_header(blob); - if (err == 0) - return 1; /* valid */ - - if (err < 0) { - printf("libfdt fdt_check_header(): %s", fdt_strerror(err)); - /* - * Be more informative on bad version. - */ - if (err == -FDT_ERR_BADVERSION) { - if (fdt_version(blob) < - FDT_FIRST_SUPPORTED_VERSION) { - printf (" - too old, fdt %d < %d", - fdt_version(blob), - FDT_FIRST_SUPPORTED_VERSION); - } - if (fdt_last_comp_version(blob) > - FDT_LAST_SUPPORTED_VERSION) { - printf (" - too new, fdt %d > %d", - fdt_version(blob), - FDT_LAST_SUPPORTED_VERSION); - } - } - printf("\n"); - *blobp = NULL; - return 0; - } - return 1; -} - -/****************************************************************************/ - /* * Parse the user's input, partially heuristic. Valid formats: * <0x00112233 4 05> - an array of cells. Numbers follow standard diff --git a/common/fdt_support.c b/common/fdt_support.c index 5ae75df3c6..84ee274c72 100644 --- a/common/fdt_support.c +++ b/common/fdt_support.c @@ -1814,3 +1814,49 @@ int fdt_overlay_apply_verbose(void *fdt, void *fdto) return err; } #endif + +/** + * fdt_valid() - Check if an FDT is valid. If not, change it to NULL + * + * @blobp: Pointer to FDT pointer + * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL) + */ +int fdt_valid(struct fdt_header **blobp) +{ + const void *blob = *blobp; + int err; + + if (!blob) { + printf("The address of the fdt is invalid (NULL).\n"); + return 0; + } + + err = fdt_check_header(blob); + if (err == 0) + return 1; /* valid */ + + if (err < 0) { + printf("libfdt fdt_check_header(): %s", fdt_strerror(err)); + /* + * Be more informative on bad version. + */ + if (err == -FDT_ERR_BADVERSION) { + if (fdt_version(blob) < + FDT_FIRST_SUPPORTED_VERSION) { + printf(" - too old, fdt %d < %d", + fdt_version(blob), + FDT_FIRST_SUPPORTED_VERSION); + } + if (fdt_last_comp_version(blob) > + FDT_LAST_SUPPORTED_VERSION) { + printf(" - too new, fdt %d > %d", + fdt_version(blob), + FDT_LAST_SUPPORTED_VERSION); + } + } + printf("\n"); + *blobp = NULL; + return 0; + } + return 1; +} diff --git a/include/fdt_support.h b/include/fdt_support.h index dbbac0fb6a..fab8df0bcb 100644 --- a/include/fdt_support.h +++ b/include/fdt_support.h @@ -328,6 +328,8 @@ int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
int fdt_overlay_apply_verbose(void *fdt, void *fdto);
+int fdt_valid(struct fdt_header **blobp); + /** * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes *

This patch adds a new "extension" command, which aims at detecting extension boards connected to the hardware platform, and apply the Device Tree overlays that describe the hardware present on those extension boards.
In order to enable this mechanism, board-specific code must implement the extension_board_scan() function that fills in a linked list of "struct extension", each describing one extension board. In addition, the board-specific code must select the SUPPORT_EXTENSION_SCAN Kconfig boolean.
Based on this:
- "extension scan" makes the generic code call the board-specific extension_board_scan() function to retrieve the list of detected extension boards.
- "extension list" allows to list the detected extension boards.
- "extension apply <number>|all" allows to apply the Device Tree overlay(s) corresponding to one, or all, extension boards
The latter requires two environment variables to exist:
- extension_overlay_addr: the RAM address where to load the Device Tree overlays
- extension_overlay_cmd: the U-Boot command to load one overlay. Indeed, the location and mechanism to load DT overlays is very setup specific.
When calling the command described in the extension_overlay_cmd variable, the variable extension_overlay_name will be defined. So a typical extension_overlay_cmd will look like this:
extension_overlay_cmd=load mmc 0:1 $extension_overlay_addr /boot/$extension_overlay_name
Here is an example on how to use it: => run loadfdt => fdt addr $fdtaddr => setenv extension_overlay_addr 0x1000 => setenv extension_overlay_cmd 'load mmc 0:1 ${extension_overlay_addr} /boot/${extension_overlay_name}' => extension scan Found 1 extension board(s). => extension apply 0 519 bytes read in 3 ms (168.9 KiB/s)
Signed-off-by: Kory Maincent kory.maincent@bootlin.com ---
Change since v1: - add list_for_each_entry loop bracket - move doc location and update it to rST
cmd/Kconfig | 12 +++ cmd/Makefile | 1 + cmd/extension_board.c | 167 ++++++++++++++++++++++++++++++++++++++ doc/usage/extension.rst | 111 +++++++++++++++++++++++++ include/extension_board.h | 31 +++++++ 5 files changed, 322 insertions(+) create mode 100644 cmd/extension_board.c create mode 100644 doc/usage/extension.rst create mode 100644 include/extension_board.h
diff --git a/cmd/Kconfig b/cmd/Kconfig index 1595de999b..90be5c260a 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -314,6 +314,18 @@ config CMD_FDT help Do FDT related setup before booting into the Operating System.
+config SUPPORT_EXTENSION_SCAN + bool + +config CMD_EXTENSION + bool "Extension board management command" + select CMD_FDT + depends on SUPPORT_EXTENSION_SCAN + help + Enables the "extension" command, which allows to detect + extension boards connected to the system, and apply + corresponding Device Tree overlays. + config CMD_GO bool "go" default y diff --git a/cmd/Makefile b/cmd/Makefile index dd86675bf2..87da67d27d 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -53,6 +53,7 @@ obj-$(CONFIG_CMD_DIAG) += diag.o endif obj-$(CONFIG_CMD_ADTIMG) += adtimg.o obj-$(CONFIG_CMD_ABOOTIMG) += abootimg.o +obj-$(CONFIG_CMD_EXTENSION) += extension_board.o obj-$(CONFIG_CMD_ECHO) += echo.o obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o obj-$(CONFIG_CMD_EEPROM) += eeprom.o diff --git a/cmd/extension_board.c b/cmd/extension_board.c new file mode 100644 index 0000000000..6ad9765d84 --- /dev/null +++ b/cmd/extension_board.c @@ -0,0 +1,167 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * (C) Copyright 2021 + * Köry Maincent, Bootlin, kory.maincent@bootlin.com + */ + +#include <common.h> +#include <command.h> +#include <malloc.h> +#include <extension_board.h> +#include <mapmem.h> +#include <linux/libfdt.h> +#include <fdt_support.h> + +static LIST_HEAD(extension_list); + +static int extension_apply(struct extension *extension) +{ + char *overlay_cmd; + ulong extrasize, overlay_addr; + struct fdt_header *blob; + + if (!working_fdt) { + printf("No FDT memory address configured. Please configure\n" + "the FDT address via "fdt addr <address>" command.\n"); + return CMD_RET_FAILURE; + } + + overlay_cmd = env_get("extension_overlay_cmd"); + if (!overlay_cmd) { + printf("Environment extension_overlay_cmd is missing\n"); + return CMD_RET_FAILURE; + } + + overlay_addr = env_get_hex("extension_overlay_addr", 0); + if (!overlay_addr) { + printf("Environment extension_overlay_addr is missing\n"); + return CMD_RET_FAILURE; + } + + env_set("extension_overlay_name", extension->overlay); + if (run_command(overlay_cmd, 0) != 0) + return CMD_RET_FAILURE; + + extrasize = env_get_hex("filesize", 0); + if (!extrasize) + return CMD_RET_FAILURE; + + fdt_shrink_to_minimum(working_fdt, extrasize); + + blob = map_sysmem(overlay_addr, 0); + if (!fdt_valid(&blob)) + return CMD_RET_FAILURE; + + /* apply method prints messages on error */ + if (fdt_overlay_apply_verbose(working_fdt, blob)) + return CMD_RET_FAILURE; + + return CMD_RET_SUCCESS; +} + +static int do_extension_list(struct cmd_tbl *cmdtp, int flag, + int argc, char *const argv[]) +{ + int i; + struct extension *extension; + + if (list_empty(&extension_list)) { + printf("No extension registered - Please run "extension scan"\n"); + return CMD_RET_SUCCESS; + } + + list_for_each_entry(extension, &extension_list, list) { + printf("Extension %d: %s\n", i++, extension->name); + printf("\tManufacturer: \t\t%s\n", extension->owner); + printf("\tVersion: \t\t%s\n", extension->version); + printf("\tDevicetree overlay: \t%s\n", extension->overlay); + printf("\tOther information: \t%s\n", extension->other); + } + return CMD_RET_SUCCESS; +} + +static int do_extension_scan(struct cmd_tbl *cmdtp, int flag, + int argc, char *const argv[]) +{ + struct extension *extension, *next; + int extension_num; + + list_for_each_entry_safe(extension, next, &extension_list, list) { + list_del(&extension->list); + free(extension); + } + extension_num = extension_board_scan(&extension_list); + + if (extension_num < 0) + return CMD_RET_FAILURE; + + printf("Found %d extension board(s).\n", extension_num); + + return CMD_RET_SUCCESS; +} + +static int do_extension_apply(struct cmd_tbl *cmdtp, int flag, + int argc, char *const argv[]) +{ + struct extension *extension = NULL; + struct list_head *entry; + int i = 0, extension_id, ret; + + if (argc < 2) + return CMD_RET_USAGE; + + if (strcmp(argv[1], "all") == 0) { + list_for_each_entry(extension, &extension_list, list) { + ret = extension_apply(extension); + if (ret != CMD_RET_SUCCESS) + break; + } + } else { + extension_id = simple_strtol(argv[1], NULL, 10); + list_for_each(entry, &extension_list) { + if (i == extension_id) { + extension = list_entry(entry, struct extension, list); + break; + } + i++; + } + + if (!extension) { + printf("Wrong extension number\n"); + return CMD_RET_FAILURE; + } + + ret = extension_apply(extension); + } + + return ret; +} + +static struct cmd_tbl cmd_extension[] = { + U_BOOT_CMD_MKENT(scan, 1, 1, do_extension_scan, "", ""), + U_BOOT_CMD_MKENT(list, 1, 0, do_extension_list, "", ""), + U_BOOT_CMD_MKENT(apply, 2, 0, do_extension_apply, "", ""), +}; + +static int do_extensionops(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]) +{ + struct cmd_tbl *cp; + + /* Drop the extension command */ + argc--; + argv++; + + cp = find_cmd_tbl(argv[0], cmd_extension, ARRAY_SIZE(cmd_extension)); + if (cp) + return cp->cmd(cmdtp, flag, argc, argv); + + return CMD_RET_USAGE; +} + +U_BOOT_CMD(extension, 3, 1, do_extensionops, + "Extension board management sub system", + "scan - scan plugged extension(s) board(s)\n" + "extension list - lists available extension(s) board(s)\n" + "extension apply <extension number|all> - applies DT overlays corresponding to extension boards\n" +); diff --git a/doc/usage/extension.rst b/doc/usage/extension.rst new file mode 100644 index 0000000000..2b88398b18 --- /dev/null +++ b/doc/usage/extension.rst @@ -0,0 +1,111 @@ +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright 2021, Kory Maincent kory.maincent@bootlin.com + +U-Boot extension board usage (CONFIG_EXTENSION) +=============================================== + +Synopsis +-------- + +:: + + extension scan + extension list + extension apply <extension number|all> + +Description +----------- + +The "extension" command proposes a generic U-Boot mechanism to detect +extension boards connected to the HW platform, and apply the appropriate +Device Tree overlays depending on the detected extension boards. + +The "extension" command comes with three sub-commands: + + - "extension scan" makes the generic code call the board-specific + extension_board_scan() function to retrieve the list of detected + extension boards. + + - "extension list" allows to list the detected extension boards. + + - "extension apply <number>|all" allows to apply the Device Tree + overlay(s) corresponding to one, or all, extension boards + +The latter requires two environment variables to exist: + + - extension_overlay_addr: the RAM address where to load the Device + Tree overlays + + - extension_overlay_cmd: the U-Boot command to load one overlay. + Indeed, the location and mechanism to load DT overlays is very setup + specific. + +In order to enable this mechanism, board-specific code must implement +the extension_board_scan() function that fills in a linked list of +"struct extension", each describing one extension board. In addition, +the board-specific code must select the SUPPORT_EXTENSION_SCAN Kconfig +boolean. + +Usage example +------------- + +1. Make sure your devicetree is loaded and set as the working fdt tree. + +:: + + => run loadfdt + => fdt addr $fdtaddr + +2. Prepare the environment variables + +:: + + => setenv extension_overlay_addr 0x88080000 + => setenv extension_overlay_cmd 'load mmc 0:1 ${extension_overlay_addr} /boot/${extension_overlay_name}' + +3. Detect the plugged extension board + +:: + + => extension scan + +4. List the plugged extension board information and the devicetree + overlay name + +:: + + => extension list + +5. Apply the appropriate devicetree overlay + +For apply the selected overlay: + +:: + + => extension apply 0 + +For apply all the overlays: + +:: + + => extension apply all + +Simple extension_board_scan function example +-------------------------------------------- + +.. code-block:: c + + int extension_board_scan(struct list_head *extension_list) + { + struct extension *extension; + + extension = calloc(1, sizeof(struct extension)); + snprintf(extension->overlay, sizeof(extension->overlay), "overlay.dtbo"); + snprintf(extension->name, sizeof(extension->name), "extension board"); + snprintf(extension->owner, sizeof(extension->owner), "sandbox"); + snprintf(extension->version, sizeof(extension->version), "1.1"); + snprintf(extension->other, sizeof(extension->other), "Extension board information"); + list_add_tail(&extension->list, extension_list); + + return 1; + } diff --git a/include/extension_board.h b/include/extension_board.h new file mode 100644 index 0000000000..c530a0ad8a --- /dev/null +++ b/include/extension_board.h @@ -0,0 +1,31 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* + * (C) Copyright 2021 + * Köry Maincent, Bootlin, kory.maincent@bootlin.com + */ + +#ifndef __EXTENSION_SUPPORT_H +#define __EXTENSION_SUPPORT_H + +struct extension { + struct list_head list; + char name[32]; + char owner[32]; + char version[32]; + char overlay[32]; + char other[32]; +}; + +/** + * extension_board_scan - Add system-specific function to scan extension board. + * @param extension_list List of extension board information to update. + * @return the number of extension. + * + * This function is called if CONFIG_CMD_EXTENSION is defined. + * Needs to fill the list extension_list with elements. + * Each element need to be allocated to an extension structure. + * + */ +int extension_board_scan(struct list_head *extension_list); + +#endif /* __EXTENSION_SUPPORT_H */

This commit extends the sandbox to implement a dummy extension_board_scan() function and enables the extension command in the sandbox configuration. It then adds a test that checks the proper functionality of the extension command by applying two Device Tree overlays to the sandbox Device Tree.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com --- arch/Kconfig | 2 ++ arch/sandbox/dts/Makefile | 1 + arch/sandbox/dts/overlay0.dts | 9 ++++++ arch/sandbox/dts/overlay1.dts | 9 ++++++ board/sandbox/sandbox.c | 23 +++++++++++++++ test/py/tests/test_extension.py | 52 +++++++++++++++++++++++++++++++++ 6 files changed, 96 insertions(+) create mode 100644 arch/sandbox/dts/overlay0.dts create mode 100644 arch/sandbox/dts/overlay1.dts create mode 100644 test/py/tests/test_extension.py
diff --git a/arch/Kconfig b/arch/Kconfig index 3aa99e08fc..fbe969cce0 100644 --- a/arch/Kconfig +++ b/arch/Kconfig @@ -109,6 +109,7 @@ config SANDBOX select SPI select SUPPORT_OF_CONTROL select SYSRESET_CMD_POWEROFF + select SUPPORT_EXTENSION_SCAN imply BITREVERSE select BLOBLIST imply CMD_DM @@ -146,6 +147,7 @@ config SANDBOX imply ACPI_PMC_SANDBOX imply CMD_PMC imply CMD_CLONE + imply CMD_EXTENSION
config SH bool "SuperH architecture" diff --git a/arch/sandbox/dts/Makefile b/arch/sandbox/dts/Makefile index d231dc2877..3e5dc67d53 100644 --- a/arch/sandbox/dts/Makefile +++ b/arch/sandbox/dts/Makefile @@ -6,6 +6,7 @@ else dtb-$(CONFIG_SANDBOX) += sandbox.dtb endif dtb-$(CONFIG_UT_DM) += test.dtb +dtb-$(CONFIG_CMD_EXTENSION) += overlay0.dtbo overlay1.dtbo
targets += $(dtb-y)
diff --git a/arch/sandbox/dts/overlay0.dts b/arch/sandbox/dts/overlay0.dts new file mode 100644 index 0000000000..70c6cf77aa --- /dev/null +++ b/arch/sandbox/dts/overlay0.dts @@ -0,0 +1,9 @@ +/dts-v1/; +/plugin/; + +&{/buttons} { + btn3 { + gpios = <&gpio_a 5 0>; + label = "button3"; + }; +}; diff --git a/arch/sandbox/dts/overlay1.dts b/arch/sandbox/dts/overlay1.dts new file mode 100644 index 0000000000..51621b3110 --- /dev/null +++ b/arch/sandbox/dts/overlay1.dts @@ -0,0 +1,9 @@ +/dts-v1/; +/plugin/; + +&{/buttons} { + btn4 { + gpios = <&gpio_a 5 0>; + label = "button4"; + }; +}; diff --git a/board/sandbox/sandbox.c b/board/sandbox/sandbox.c index 18a605de02..6ba1a7177d 100644 --- a/board/sandbox/sandbox.c +++ b/board/sandbox/sandbox.c @@ -13,6 +13,9 @@ #include <os.h> #include <asm/test.h> #include <asm/u-boot-sandbox.h> +#include <malloc.h> + +#include <extension_board.h>
/* * Pointer to initial global data area @@ -81,6 +84,26 @@ int ft_board_setup(void *fdt, struct bd_info *bd) return fdt_add_mem_rsv(fdt, 0x00d02000, 0x4000); }
+#ifdef CONFIG_CMD_EXTENSION +int extension_board_scan(struct list_head *extension_list) +{ + struct extension *extension; + int i; + + for (i = 0; i < 2; i++) { + extension = calloc(1, sizeof(struct extension)); + snprintf(extension->overlay, sizeof(extension->overlay), "overlay%d.dtbo", i); + snprintf(extension->name, sizeof(extension->name), "extension board %d", i); + snprintf(extension->owner, sizeof(extension->owner), "sandbox"); + snprintf(extension->version, sizeof(extension->version), "1.1"); + snprintf(extension->other, sizeof(extension->other), "Fictionnal extension board"); + list_add_tail(&extension->list, extension_list); + } + + return i; +} +#endif + #ifdef CONFIG_BOARD_LATE_INIT int board_late_init(void) { diff --git a/test/py/tests/test_extension.py b/test/py/tests/test_extension.py new file mode 100644 index 0000000000..4712f9bfe3 --- /dev/null +++ b/test/py/tests/test_extension.py @@ -0,0 +1,52 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Copyright (c) 2020 +# Author: Kory Maincent kory.maincent@bootlin.com + +# Test U-Boot's "extension" commands. + +import os +import pytest +import u_boot_utils + +overlay_addr = 0x1000 + +SANDBOX_DTB='arch/sandbox/dts/sandbox.dtb' +OVERLAY_DIR='arch/sandbox/dts/' + +def load_dtb(u_boot_console): + u_boot_console.log.action('Loading devicetree to RAM...') + u_boot_console.run_command('host load hostfs - $fdt_addr_r %s' % (os.path.join(u_boot_console.config.build_dir, SANDBOX_DTB))) + u_boot_console.run_command('fdt addr $fdt_addr_r') + +@pytest.mark.buildconfigspec('cmd_fdt') +def test_extension(u_boot_console): + """Test the 'extension' command.""" + + load_dtb(u_boot_console) + + output = u_boot_console.run_command('extension list') + assert('No extension' in output) + + output = u_boot_console.run_command('extension scan') + assert output == 'Found 2 extension board(s).' + + output = u_boot_console.run_command('extension list') + assert('overlay0.dtbo' in output) + assert('overlay1.dtbo' in output) + + u_boot_console.run_command_list([ + 'setenv extension_overlay_addr %s' % (overlay_addr), + 'setenv extension_overlay_cmd 'host load hostfs - ${extension_overlay_addr} %s${extension_overlay_name}'' % (os.path.join(u_boot_console.config.build_dir, OVERLAY_DIR))]) + + output = u_boot_console.run_command('extension apply 0') + assert('bytes read' in output) + + output = u_boot_console.run_command('fdt print') + assert('button3' in output) + + output = u_boot_console.run_command('extension apply all') + assert('bytes read' in output) + + output = u_boot_console.run_command('fdt print') + assert('button4' in output) +

The BeagleBone platforms all use a common mechanism to discover and identify extension boards (called "capes"): each extension board has an I2C-connected EEPROM describing itself.
This patch implements a generic extension_scan_board() feature that can be used by all BeagleBone platforms to read those I2C EEPROMs and fill in the list of "extension" structures.
Following commits will enable this common logic on two BeagleBone platforms.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com ---
Change Since v1: - use CAPE_EEPROM_BUS_NUM in Kconfig in place of the board header
board/ti/common/Kconfig | 6 +++ board/ti/common/Makefile | 1 + board/ti/common/cape_detect.c | 96 +++++++++++++++++++++++++++++++++++ board/ti/common/cape_detect.h | 28 ++++++++++ 4 files changed, 131 insertions(+) create mode 100644 board/ti/common/cape_detect.c create mode 100644 board/ti/common/cape_detect.h
diff --git a/board/ti/common/Kconfig b/board/ti/common/Kconfig index 9ead7ca038..49edd98014 100644 --- a/board/ti/common/Kconfig +++ b/board/ti/common/Kconfig @@ -16,6 +16,12 @@ config EEPROM_CHIP_ADDRESS default 0x50 depends on TI_I2C_BOARD_DETECT
+config CAPE_EEPROM_BUS_NUM + int "Cape EEPROM's I2C bus address" + range 0 8 + default 2 + depends on CMD_EXTENSION + config TI_COMMON_CMD_OPTIONS bool "Enable cmd options on TI platforms" imply CMD_ASKENV diff --git a/board/ti/common/Makefile b/board/ti/common/Makefile index cb97f226ae..3172d87b46 100644 --- a/board/ti/common/Makefile +++ b/board/ti/common/Makefile @@ -2,3 +2,4 @@ # Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com/
obj-${CONFIG_TI_I2C_BOARD_DETECT} += board_detect.o +obj-${CONFIG_CMD_EXTENSION} += cape_detect.o diff --git a/board/ti/common/cape_detect.c b/board/ti/common/cape_detect.c new file mode 100644 index 0000000000..2e6105cfbf --- /dev/null +++ b/board/ti/common/cape_detect.c @@ -0,0 +1,96 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * (C) Copyright 2021 + * Köry Maincent, Bootlin, kory.maincent@bootlin.com + */ + +#include <common.h> +#include <malloc.h> +#include <i2c.h> +#include <extension_board.h> + +#include "cape_detect.h" + +static void sanitize_field(char *text, size_t size) +{ + char *c = NULL; + + for (c = text; c < text + (int)size; c++) { + if (*c == 0xFF) + *c = 0; + } +} + +int extension_board_scan(struct list_head *extension_list) +{ + struct extension *cape; + struct am335x_cape_eeprom_id eeprom_header; + + int num_capes = 0; + int ret, i; + struct udevice *dev; + unsigned char addr; + + char process_cape_part_number[17] = {'0'}; + char process_cape_version[5] = {'0'}; + uint8_t cursor = 0; + + for (addr = CAPE_EEPROM_FIRST_ADDR; addr <= CAPE_EEPROM_LAST_ADDR; addr++) { + ret = i2c_get_chip_for_busnum(CONFIG_CAPE_EEPROM_BUS_NUM, addr, 1, &dev); + if (ret) + continue; + + /* Move the read cursor to the beginning of the EEPROM */ + dm_i2c_write(dev, 0, &cursor, 1); + ret = dm_i2c_read(dev, 0, (uint8_t *)&eeprom_header, + sizeof(struct am335x_cape_eeprom_id)); + if (ret) { + printf("Cannot read i2c EEPROM\n"); + continue; + } + + if (eeprom_header.header != CAPE_MAGIC) + continue; + + sanitize_field(eeprom_header.board_name, sizeof(eeprom_header.board_name)); + sanitize_field(eeprom_header.version, sizeof(eeprom_header.version)); + sanitize_field(eeprom_header.manufacturer, sizeof(eeprom_header.manufacturer)); + sanitize_field(eeprom_header.part_number, sizeof(eeprom_header.part_number)); + + /* Process cape part_number */ + memset(process_cape_part_number, 0, sizeof(process_cape_part_number)); + strncpy(process_cape_part_number, eeprom_header.part_number, 16); + /* Some capes end with '.' */ + for (i = 15; i >= 0; i--) { + if (process_cape_part_number[i] == '.') + process_cape_part_number[i] = '\0'; + else + break; + } + + /* Process cape version */ + memset(process_cape_version, 0, sizeof(process_cape_version)); + strncpy(process_cape_version, eeprom_header.version, 4); + for (i = 0; i < 4; i++) { + if (process_cape_version[i] == 0) + process_cape_version[i] = '0'; + } + + printf("BeagleBone Cape: %s (0x%x)\n", eeprom_header.board_name, addr); + + cape = calloc(1, sizeof(struct extension)); + if (!cape) { + printf("Error in memory allocation\n"); + return num_capes; + } + + snprintf(cape->overlay, sizeof(cape->overlay), "%s-%s.dtbo", + process_cape_part_number, process_cape_version); + strncpy(cape->name, eeprom_header.board_name, 32); + strncpy(cape->version, process_cape_version, 4); + strncpy(cape->owner, eeprom_header.manufacturer, 16); + list_add_tail(&cape->list, extension_list); + num_capes++; + } + return num_capes; +} diff --git a/board/ti/common/cape_detect.h b/board/ti/common/cape_detect.h new file mode 100644 index 0000000000..b0d5c9f18b --- /dev/null +++ b/board/ti/common/cape_detect.h @@ -0,0 +1,28 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* + * (C) Copyright 2021 + * Köry Maincent, Bootlin, kory.maincent@bootlin.com + */ + +#ifndef __CAPE_DETECT_H +#define __CAPE_DETECT_H + +struct am335x_cape_eeprom_id { + unsigned int header; + char eeprom_rev[2]; + char board_name[32]; + char version[4]; + char manufacturer[16]; + char part_number[16]; +}; + +#define CAPE_EEPROM_FIRST_ADDR 0x54 +#define CAPE_EEPROM_LAST_ADDR 0x57 + +#define CAPE_EEPROM_ADDR_LEN 0x10 + +#define CAPE_MAGIC 0xEE3355AA + +int extension_board_scan(struct list_head *extension_list); + +#endif /* __CAPE_DETECT_H */

This commit enables using the extension board detection mechanism on AM57xx based platforms.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com ---
Change Since v1: - Remove CAPE_EEPROM_BUS_NUM from the header
arch/arm/mach-omap2/omap5/Kconfig | 1 + board/ti/am57xx/board.c | 1 + 2 files changed, 2 insertions(+)
diff --git a/arch/arm/mach-omap2/omap5/Kconfig b/arch/arm/mach-omap2/omap5/Kconfig index a7132dae09..4c2f990b28 100644 --- a/arch/arm/mach-omap2/omap5/Kconfig +++ b/arch/arm/mach-omap2/omap5/Kconfig @@ -36,6 +36,7 @@ config TARGET_AM57XX_EVM select CMD_DDR3 select DRA7XX select TI_I2C_BOARD_DETECT + select SUPPORT_EXTENSION_SCAN imply DM_THERMAL imply SCSI imply SPL_THERMAL diff --git a/board/ti/am57xx/board.c b/board/ti/am57xx/board.c index 7809875510..a2df4def78 100644 --- a/board/ti/am57xx/board.c +++ b/board/ti/am57xx/board.c @@ -42,6 +42,7 @@ #include <hang.h>
#include "../common/board_detect.h" +#include "../common/cape_detect.h" #include "mux_data.h"
#ifdef CONFIG_SUPPORT_EMMC_BOOT

This patch changes the functioning of the detection of w1 devices. The old way was a comparison between detected w1 and the ones described in the device tree. Now it will just look for the right driver matching the family id of the w1 detected.
The patch is inspired from Maxime Ripart code.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com --- drivers/w1-eeprom/ds24xxx.c | 20 ++----------- drivers/w1-eeprom/ds2502.c | 18 ++--------- drivers/w1-eeprom/w1-eeprom-uclass.c | 45 ++++++++++++++++------------ drivers/w1/w1-uclass.c | 2 +- include/w1-eeprom.h | 2 +- include/w1.h | 17 +++++++++++ 6 files changed, 50 insertions(+), 54 deletions(-)
diff --git a/drivers/w1-eeprom/ds24xxx.c b/drivers/w1-eeprom/ds24xxx.c index 0967accdf0..7c245fbd71 100644 --- a/drivers/w1-eeprom/ds24xxx.c +++ b/drivers/w1-eeprom/ds24xxx.c @@ -27,29 +27,15 @@ static int ds24xxx_read_buf(struct udevice *dev, unsigned int offset, return w1_read_buf(dev, buf, count); }
-static int ds24xxx_probe(struct udevice *dev) -{ - struct w1_device *w1; - - w1 = dev_get_parent_platdata(dev); - w1->id = 0; - return 0; -} - static const struct w1_eeprom_ops ds24xxx_ops = { .read_buf = ds24xxx_read_buf, };
-static const struct udevice_id ds24xxx_id[] = { - { .compatible = "maxim,ds24b33", .data = W1_FAMILY_DS24B33 }, - { .compatible = "maxim,ds2431", .data = W1_FAMILY_DS2431 }, - { }, -}; - U_BOOT_DRIVER(ds24xxx) = { .name = "ds24xxx", .id = UCLASS_W1_EEPROM, - .of_match = ds24xxx_id, .ops = &ds24xxx_ops, - .probe = ds24xxx_probe, }; + +U_BOOT_W1_DEVICE(ds24b33, ds24xxx, W1_FAMILY_DS24B33); +U_BOOT_W1_DEVICE(ds2431, ds24xxx, W1_FAMILY_DS2431); diff --git a/drivers/w1-eeprom/ds2502.c b/drivers/w1-eeprom/ds2502.c index 19ee4b17ea..73e1cc023a 100644 --- a/drivers/w1-eeprom/ds2502.c +++ b/drivers/w1-eeprom/ds2502.c @@ -218,28 +218,14 @@ static int ds2502_read_buf(struct udevice *dev, unsigned int offset, return 0; }
-static int ds2502_probe(struct udevice *dev) -{ - struct w1_device *w1; - - w1 = dev_get_parent_platdata(dev); - w1->id = 0; - return 0; -} - static const struct w1_eeprom_ops ds2502_ops = { .read_buf = ds2502_read_buf, };
-static const struct udevice_id ds2502_id[] = { - { .compatible = "maxim,ds2502", .data = W1_FAMILY_DS2502 }, - { }, -}; - U_BOOT_DRIVER(ds2502) = { .name = "ds2502", .id = UCLASS_W1_EEPROM, - .of_match = ds2502_id, .ops = &ds2502_ops, - .probe = ds2502_probe, }; + +U_BOOT_W1_DEVICE(ds2502, ds2502, W1_FAMILY_DS2502); diff --git a/drivers/w1-eeprom/w1-eeprom-uclass.c b/drivers/w1-eeprom/w1-eeprom-uclass.c index d515b4c536..9edce7f6c5 100644 --- a/drivers/w1-eeprom/w1-eeprom-uclass.c +++ b/drivers/w1-eeprom/w1-eeprom-uclass.c @@ -37,30 +37,37 @@ int w1_eeprom_read_buf(struct udevice *dev, unsigned int offset, return ops->read_buf(dev, offset, buf, count); }
-int w1_eeprom_register_new_device(u64 id) +int w1_eeprom_register_new_device(u64 id, struct udevice *bus) { u8 family = id & 0xff; - int ret; + int n_ents, ret; struct udevice *dev;
- for (ret = uclass_first_device(UCLASS_W1_EEPROM, &dev); - !ret && dev; - uclass_next_device(&dev)) { - if (ret || !dev) { - debug("cannot find w1 eeprom dev\n"); + struct w1_driver_entry *start, *entry; + + start = ll_entry_start(struct w1_driver_entry, w1_driver_entry); + n_ents = ll_entry_count(struct w1_driver_entry, w1_driver_entry); + + for (entry = start; entry != start + n_ents; entry++) { + const struct driver *drv; + struct w1_device *w1; + struct udevice *dev; + + if (entry->family != family) + continue; + + drv = entry->driver; + ret = device_bind(bus, drv, drv->name, NULL, -1, + &dev); + if (ret) return ret; - } - if (dev_get_driver_data(dev) == family) { - struct w1_device *w1; - - w1 = dev_get_parent_platdata(dev); - if (w1->id) /* device already in use */ - continue; - w1->id = id; - debug("%s: Match found: %s:%s %llx\n", __func__, - dev->name, dev->driver->name, id); - return 0; - } + + debug("%s: Match found: %s\n", __func__, drv->name); + + w1 = dev_get_parent_platdata(dev); + w1->id = id; + + return 0; }
debug("%s: No matches found: error %d\n", __func__, ret); diff --git a/drivers/w1/w1-uclass.c b/drivers/w1/w1-uclass.c index 9478c93e9b..004d1098c8 100644 --- a/drivers/w1/w1-uclass.c +++ b/drivers/w1/w1-uclass.c @@ -98,7 +98,7 @@ static int w1_enumerate(struct udevice *bus) bus->name, rn, (u8)(rn & 0xff));
/* attempt to register as w1-eeprom device */ - w1_eeprom_register_new_device(rn); + w1_eeprom_register_new_device(rn, bus); } }
diff --git a/include/w1-eeprom.h b/include/w1-eeprom.h index 22337368b4..6d6a088e1b 100644 --- a/include/w1-eeprom.h +++ b/include/w1-eeprom.h @@ -27,7 +27,7 @@ int w1_eeprom_read_buf(struct udevice *dev, unsigned int offset,
int w1_eeprom_dm_init(void);
-int w1_eeprom_register_new_device(u64 id); +int w1_eeprom_register_new_device(u64 id, struct udevice *bus);
int w1_eeprom_get_id(struct udevice *dev, u64 *id); #endif diff --git a/include/w1.h b/include/w1.h index 77f439e587..11506a6c9f 100644 --- a/include/w1.h +++ b/include/w1.h @@ -15,6 +15,23 @@ struct udevice; #define W1_FAMILY_DS2502 0x09 #define W1_FAMILY_EEP_SANDBOX 0xfe
+struct w1_driver_entry { + struct driver *driver; + u8 family; +}; + +/* U_BOOT_W1_DEVICE() tells U-Boot to create a one-wire device. + * + * @__name: Device name (C identifier, not a string. E.g. gpio7_at_ff7e0000) + * @__driver: Driver name (C identifier, not a string. E.g. gpio7_at_ff7e0000) + * @__family: Family code number of the one-wire + */ +#define U_BOOT_W1_DEVICE(__name, __driver, __family) \ + ll_entry_declare(struct w1_driver_entry, __name, w1_driver_entry) = { \ + .driver = llsym(struct driver, __driver, driver), \ + .family = __family, \ + } + struct w1_device { u64 id; };

Remove the sandbox w1 eeprom driver. The detection of w1 is now automatic and does not depend on the devicetree, therefore this driver can not be loaded anymore.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com --- drivers/w1-eeprom/Makefile | 2 -- drivers/w1-eeprom/eep_sandbox.c | 61 --------------------------------- 2 files changed, 63 deletions(-) delete mode 100644 drivers/w1-eeprom/eep_sandbox.c
diff --git a/drivers/w1-eeprom/Makefile b/drivers/w1-eeprom/Makefile index 83f4008bb5..b725edde84 100644 --- a/drivers/w1-eeprom/Makefile +++ b/drivers/w1-eeprom/Makefile @@ -2,5 +2,3 @@ obj-$(CONFIG_W1_EEPROM) += w1-eeprom-uclass.o
obj-$(CONFIG_W1_EEPROM_DS24XXX) += ds24xxx.o obj-$(CONFIG_W1_EEPROM_DS2502) += ds2502.o - -obj-$(CONFIG_W1_EEPROM_SANDBOX) += eep_sandbox.o diff --git a/drivers/w1-eeprom/eep_sandbox.c b/drivers/w1-eeprom/eep_sandbox.c deleted file mode 100644 index 27c7f9f1b6..0000000000 --- a/drivers/w1-eeprom/eep_sandbox.c +++ /dev/null @@ -1,61 +0,0 @@ -/* SPDX-License-Identifier: GPL-2.0+ - * - * Copyright (c) 2018 Microchip Technology, Inc. - * - */ - -#include <common.h> -#include <linux/err.h> -#include <dm.h> -#include <w1-eeprom.h> -#include <w1.h> - -#define W1_F2D_READ_EEPROM 0xf0 - -#define EEP_SANDBOX_SAMPLE_MEM "this is a sample EEPROM memory string." - -static int eep_sandbox_read_buf(struct udevice *dev, unsigned int offset, - u8 *buf, unsigned int count) -{ - /* do not allow to copy more than our maximum sample string */ - if (offset + count < strlen(EEP_SANDBOX_SAMPLE_MEM)) { - offset = 0; - count = strlen(EEP_SANDBOX_SAMPLE_MEM); - } - strncpy((char *)buf, EEP_SANDBOX_SAMPLE_MEM, count); - - /* - * in case the w1 subsystem uses some different kind of sandbox testing, - * like randomized gpio values , we take the buffer from there - */ - - w1_reset_select(dev); - - w1_write_byte(dev, W1_F2D_READ_EEPROM); - w1_write_byte(dev, offset & 0xff); - w1_write_byte(dev, offset >> 8); - - w1_read_buf(dev, buf, count); - - /* - * even if read buf from w1 fails, return success as we hardcoded - * the buffer. - */ - return 0; -} - -static const struct w1_eeprom_ops eep_sandbox_ops = { - .read_buf = eep_sandbox_read_buf, -}; - -static const struct udevice_id eep_sandbox_id[] = { - { .compatible = "sandbox,w1-eeprom", .data = W1_FAMILY_EEP_SANDBOX }, - { }, -}; - -U_BOOT_DRIVER(eep_sandbox) = { - .name = "eep_sandbox", - .id = UCLASS_W1_EEPROM, - .of_match = eep_sandbox_id, - .ops = &eep_sandbox_ops, -};

Hi,
On Tue, Mar 02, 2021 at 10:58:08AM +0100, Kory Maincent wrote:
Remove the sandbox w1 eeprom driver. The detection of w1 is now automatic and does not depend on the devicetree, therefore this driver can not be loaded anymore.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com
It's not really great to remove some tests in general, and it should at least be mentioned in your cover letter.
It's not really clear to me why you need to remove it. Sure, you won't be able to rely on the bus discovering itself in the sandbox, but AFAIK other discoverable buses have a way to register devices found on that bus, through the DT or some API
Maxime

Remove the sandbox example of one-wire node because the detection of w1 is now automatic and does not depend on the devicetree. Remove the devicetree binding document.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com --- arch/sandbox/dts/sandbox.dtsi | 18 ---------- .../w1-eeprom/eep_sandbox.txt | 34 ------------------- 2 files changed, 52 deletions(-) delete mode 100644 doc/device-tree-bindings/w1-eeprom/eep_sandbox.txt
diff --git a/arch/sandbox/dts/sandbox.dtsi b/arch/sandbox/dts/sandbox.dtsi index 81cdc55b0d..8ae783a0c6 100644 --- a/arch/sandbox/dts/sandbox.dtsi +++ b/arch/sandbox/dts/sandbox.dtsi @@ -185,11 +185,6 @@ function = "serial"; };
- pinctrl_onewire0: onewire0 { - groups = "w1"; - function = "w1"; - bias-pull-up; - }; };
reset@1 { @@ -376,19 +371,6 @@ }; };
- onewire0: onewire { - compatible = "w1-gpio"; - gpios = <&gpio_a 8>; - pinctrl-names = "default"; - pinctrl-0 = <&pinctrl_onewire0>; - status = "okay"; - - sandbox_eeprom0: sandbox_eeprom@0 { - compatible = "sandbox,w1-eeprom"; - status = "okay"; - }; - }; - sandbox_tee { compatible = "sandbox,tee"; }; diff --git a/doc/device-tree-bindings/w1-eeprom/eep_sandbox.txt b/doc/device-tree-bindings/w1-eeprom/eep_sandbox.txt deleted file mode 100644 index 82bb5899af..0000000000 --- a/doc/device-tree-bindings/w1-eeprom/eep_sandbox.txt +++ /dev/null @@ -1,34 +0,0 @@ -Onewire EEPROM sandbox driver device binding - one wire protocol sandbox EEPROM -======================= - -This memory needs to be connected to a onewire bus, as a child node. -The bus will read the device serial number and match this node with a found -device on the bus -Also check doc/device-tree-bindings/w1 for onewire bus drivers - -Driver: -- drivers/w1-eeprom/eep_sandbox.c - -Software ds24xxx device-tree node properties: -Required: -* compatible = "sandbox,w1-eeprom" - -Optional: -* none - -Example: - eeprom1: eeprom@0 { - compatible = "sandbox,w1-eeprom"; - } - -Example with parent bus: - -onewire_tm: onewire { - compatible = "w1-gpio"; - gpios = <&gpio_a 8>; - - eeprom1: eeprom@0 { - compatible = "sandbox,w1-eeprom"; - } -}; -

The CHIP board use one-wire EEPROM to discover and identify extension boards (called "DIPs").
This commit add a Kconfig configuration for the CHIP board to enable the EEPROM one-wire driver.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com ---
Need the following patches series to fix a one-wire gpio issue. https://lists.denx.de/pipermail/u-boot/2021-February/440073.html
Change since v1: - Replace TARGET_CHIP options by CHIP_DIP_SCAN
arch/arm/mach-sunxi/Kconfig | 7 +++++++ configs/CHIP_defconfig | 1 + 2 files changed, 8 insertions(+)
diff --git a/arch/arm/mach-sunxi/Kconfig b/arch/arm/mach-sunxi/Kconfig index 49ef217f08..4160d52501 100644 --- a/arch/arm/mach-sunxi/Kconfig +++ b/arch/arm/mach-sunxi/Kconfig @@ -1017,3 +1017,10 @@ config PINEPHONE_DT_SELECTION correct PinePhone hardware revision during boot.
endif + +config CHIP_DIP_SCAN + bool "Enable DIPs detection for CHIP board" + select W1 + select W1_GPIO + select W1_EEPROM + select W1_EEPROM_DS24XXX diff --git a/configs/CHIP_defconfig b/configs/CHIP_defconfig index a70ee31d40..8d40da090b 100644 --- a/configs/CHIP_defconfig +++ b/configs/CHIP_defconfig @@ -1,6 +1,7 @@ CONFIG_ARM=y CONFIG_ARCH_SUNXI=y CONFIG_SPL=y +CONFIG_CHIP_DIP_SCAN=y CONFIG_MACH_SUN5I=y CONFIG_DRAM_TIMINGS_DDR3_800E_1066G_1333J=y CONFIG_USB0_VBUS_PIN="PB10"

Add the extension_board_scan specific function to scan the information of the EEPROM on one-wire and fill the extension struct.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com --- arch/arm/mach-sunxi/Kconfig | 2 + board/sunxi/Makefile | 1 + board/sunxi/chip.c | 104 ++++++++++++++++++++++++++++++++++++ 3 files changed, 107 insertions(+) create mode 100644 board/sunxi/chip.c
diff --git a/arch/arm/mach-sunxi/Kconfig b/arch/arm/mach-sunxi/Kconfig index 4160d52501..2b6ba873ff 100644 --- a/arch/arm/mach-sunxi/Kconfig +++ b/arch/arm/mach-sunxi/Kconfig @@ -1020,7 +1020,9 @@ endif
config CHIP_DIP_SCAN bool "Enable DIPs detection for CHIP board" + select SUPPORT_EXTENSION_SCAN select W1 select W1_GPIO select W1_EEPROM select W1_EEPROM_DS24XXX + imply CMD_EXTENSION diff --git a/board/sunxi/Makefile b/board/sunxi/Makefile index c4e13f8c38..d96b7897b6 100644 --- a/board/sunxi/Makefile +++ b/board/sunxi/Makefile @@ -11,3 +11,4 @@ obj-$(CONFIG_SUN7I_GMAC) += gmac.o obj-$(CONFIG_MACH_SUN4I) += dram_sun4i_auto.o obj-$(CONFIG_MACH_SUN5I) += dram_sun5i_auto.o obj-$(CONFIG_MACH_SUN7I) += dram_sun5i_auto.o +obj-$(CONFIG_CHIP_DIP_SCAN) += chip.o diff --git a/board/sunxi/chip.c b/board/sunxi/chip.c new file mode 100644 index 0000000000..fc3d14e497 --- /dev/null +++ b/board/sunxi/chip.c @@ -0,0 +1,104 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * (C) Copyright 2021 + * Köry Maincent, Bootlin, kory.maincent@bootlin.com + * Based on initial code from Maxime Ripard + */ + +#include <common.h> +#include <malloc.h> +#include <dm.h> +#include <w1.h> +#include <w1-eeprom.h> +#include <dm/device-internal.h> + +#include <asm/arch/gpio.h> + +#include <extension_board.h> + +#ifdef CONFIG_CMD_EXTENSION + +#define for_each_1w_device(b, d) \ + for (device_find_first_child(b, d); *d; device_find_next_child(d)) + +#define dip_convert(field) \ + ( \ + (sizeof(field) == 1) ? field : \ + (sizeof(field) == 2) ? be16_to_cpu(field) : \ + (sizeof(field) == 4) ? be32_to_cpu(field) : \ + -1 \ + ) + +#define DIP_MAGIC 0x50494843 /* CHIP */ + +struct dip_w1_header { + u32 magic; /* CHIP */ + u8 version; /* spec version */ + u32 vendor_id; + u16 product_id; + u8 product_version; + char vendor_name[32]; + char product_name[32]; + u8 rsvd[36]; /* rsvd for future spec versions */ + u8 data[16]; /* user data, per-dip specific */ +} __packed; + +int extension_board_scan(struct list_head *extension_list) +{ + struct extension *dip; + struct dip_w1_header w1_header; + struct udevice *bus, *dev; + u32 vid; + u16 pid; + int ret; + + int num_dip = 0; + + sunxi_gpio_set_pull(SUNXI_GPD(2), SUNXI_GPIO_PULL_UP); + + ret = w1_get_bus(0, &bus); + if (ret) { + printf("one wire interface not found\n"); + return 0; + } + + for_each_1w_device(bus, &dev) { + if (w1_get_device_family(dev) != W1_FAMILY_DS2431) + continue; + + ret = device_probe(dev); + if (ret) { + printf("Couldn't probe device %s: error %d", + dev->name, ret); + continue; + } + + w1_eeprom_read_buf(dev, 0, (u8 *)&w1_header, sizeof(w1_header)); + + if (w1_header.magic != DIP_MAGIC) + continue; + + vid = dip_convert(w1_header.vendor_id); + pid = dip_convert(w1_header.product_id); + + printf("DIP: %s (0x%x) from %s (0x%x)\n", + w1_header.product_name, pid, + w1_header.vendor_name, vid); + + dip = calloc(1, sizeof(struct extension)); + if (!dip) { + printf("Error in memory allocation\n"); + return num_dip; + } + + snprintf(dip->overlay, sizeof(dip->overlay), "dip-%x-%x.dtbo", + vid, pid); + strncpy(dip->name, w1_header.product_name, 32); + strncpy(dip->owner, w1_header.vendor_name, 32); + list_add_tail(&dip->list, extension_list); + num_dip++; + } + return num_dip; +} + +#endif /* CONFIG_CMD_EXTENSION */

Hi,
On Tue, Mar 02, 2021 at 10:58:11AM +0100, Kory Maincent wrote:
Add the extension_board_scan specific function to scan the information of the EEPROM on one-wire and fill the extension struct.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com
arch/arm/mach-sunxi/Kconfig | 2 + board/sunxi/Makefile | 1 + board/sunxi/chip.c | 104 ++++++++++++++++++++++++++++++++++++ 3 files changed, 107 insertions(+) create mode 100644 board/sunxi/chip.c
diff --git a/arch/arm/mach-sunxi/Kconfig b/arch/arm/mach-sunxi/Kconfig index 4160d52501..2b6ba873ff 100644 --- a/arch/arm/mach-sunxi/Kconfig +++ b/arch/arm/mach-sunxi/Kconfig @@ -1020,7 +1020,9 @@ endif
config CHIP_DIP_SCAN bool "Enable DIPs detection for CHIP board"
- select SUPPORT_EXTENSION_SCAN select W1 select W1_GPIO select W1_EEPROM select W1_EEPROM_DS24XXX
- imply CMD_EXTENSION
diff --git a/board/sunxi/Makefile b/board/sunxi/Makefile index c4e13f8c38..d96b7897b6 100644 --- a/board/sunxi/Makefile +++ b/board/sunxi/Makefile @@ -11,3 +11,4 @@ obj-$(CONFIG_SUN7I_GMAC) += gmac.o obj-$(CONFIG_MACH_SUN4I) += dram_sun4i_auto.o obj-$(CONFIG_MACH_SUN5I) += dram_sun5i_auto.o obj-$(CONFIG_MACH_SUN7I) += dram_sun5i_auto.o +obj-$(CONFIG_CHIP_DIP_SCAN) += chip.o
The split of that patch and the previous one is weird: you're adding a Kconfig symbol doing close to nothing in patch 9, and you add the logic behind it here
It would be more natural to have the Kconfig option and the code here, and
diff --git a/board/sunxi/chip.c b/board/sunxi/chip.c new file mode 100644 index 0000000000..fc3d14e497 --- /dev/null +++ b/board/sunxi/chip.c @@ -0,0 +1,104 @@ +// SPDX-License-Identifier: GPL-2.0+ +/*
- (C) Copyright 2021
- Köry Maincent, Bootlin, kory.maincent@bootlin.com
- Based on initial code from Maxime Ripard
- */
+#include <common.h> +#include <malloc.h> +#include <dm.h> +#include <w1.h> +#include <w1-eeprom.h> +#include <dm/device-internal.h>
+#include <asm/arch/gpio.h>
+#include <extension_board.h>
+#ifdef CONFIG_CMD_EXTENSION
+#define for_each_1w_device(b, d) \
- for (device_find_first_child(b, d); *d; device_find_next_child(d))
The name is inconsistent with the rest of the 1-wire acronyms in the file (1w vs w1)
Also, reusing macro arguments is fairly dangerous but since it's used only once we don't really need that macro?
Maxime

Hello Maxime,
Thanks for your review.
On Tue, 2 Mar 2021 17:05:38 +0100 Maxime Ripard maxime@cerno.tech wrote:
The split of that patch and the previous one is weird: you're adding a Kconfig symbol doing close to nothing in patch 9, and you add the logic behind it here
It would be more natural to have the Kconfig option and the code here, and
Ok I will merge them into one commit.
diff --git a/board/sunxi/chip.c b/board/sunxi/chip.c new file mode 100644 index 0000000000..fc3d14e497 --- /dev/null +++ b/board/sunxi/chip.c @@ -0,0 +1,104 @@ +// SPDX-License-Identifier: GPL-2.0+ +/*
- (C) Copyright 2021
- Köry Maincent, Bootlin, kory.maincent@bootlin.com
- Based on initial code from Maxime Ripard
- */
+#include <common.h> +#include <malloc.h> +#include <dm.h> +#include <w1.h> +#include <w1-eeprom.h> +#include <dm/device-internal.h>
+#include <asm/arch/gpio.h>
+#include <extension_board.h>
+#ifdef CONFIG_CMD_EXTENSION
+#define for_each_1w_device(b, d) \
- for (device_find_first_child(b, d); *d;
device_find_next_child(d))
The name is inconsistent with the rest of the 1-wire acronyms in the file (1w vs w1)
Yes, I didn't notice this.
Also, reusing macro arguments is fairly dangerous but since it's used only once we don't really need that macro?
It was to increase the readability of the loop, but if you judge it not pertinent I can remove it.

On Tue, Mar 02, 2021 at 05:14:44PM +0100, Köry Maincent wrote:
Hello Maxime,
Thanks for your review.
On Tue, 2 Mar 2021 17:05:38 +0100 Maxime Ripard maxime@cerno.tech wrote:
The split of that patch and the previous one is weird: you're adding a Kconfig symbol doing close to nothing in patch 9, and you add the logic behind it here
It would be more natural to have the Kconfig option and the code here, and
Ok I will merge them into one commit.
Sorry my sentence was incomplete, I meant to say
and enable the Kconfig symbol in another patch
Maxime

The am335x from BeagleBone use i2c EEPROM to detect capes. The memory is wired to i2c bus 2 therefore it need to be enabled.
Add i2c2 clock, pinmux description and pinmux enable function.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com --- arch/arm/mach-omap2/am33xx/clock_am33xx.c | 1 + board/ti/am335x/board.c | 2 ++ board/ti/am335x/board.h | 1 + board/ti/am335x/mux.c | 15 +++++++++++++++ 4 files changed, 19 insertions(+)
diff --git a/arch/arm/mach-omap2/am33xx/clock_am33xx.c b/arch/arm/mach-omap2/am33xx/clock_am33xx.c index 2427933c8b..7c67444024 100644 --- a/arch/arm/mach-omap2/am33xx/clock_am33xx.c +++ b/arch/arm/mach-omap2/am33xx/clock_am33xx.c @@ -220,6 +220,7 @@ void enable_basic_clocks(void) &cmper->gpio2clkctrl, &cmper->gpio3clkctrl, &cmper->i2c1clkctrl, + &cmper->i2c2clkctrl, &cmper->cpgmac0clkctrl, &cmper->spi0clkctrl, &cmrtc->rtcclkctrl, diff --git a/board/ti/am335x/board.c b/board/ti/am335x/board.c index 984cc5e3ba..56cdda856c 100644 --- a/board/ti/am335x/board.c +++ b/board/ti/am335x/board.c @@ -76,8 +76,10 @@ static struct ctrl_dev *cdev = (struct ctrl_dev *)CTRL_DEVICE_BASE; void do_board_detect(void) { enable_i2c0_pin_mux(); + enable_i2c2_pin_mux(); #ifndef CONFIG_DM_I2C i2c_init(CONFIG_SYS_OMAP24_I2C_SPEED, CONFIG_SYS_OMAP24_I2C_SLAVE); + i2c_init(CONFIG_SYS_OMAP24_I2C_SPEED2, CONFIG_SYS_OMAP24_I2C_SLAVE2); #endif if (ti_i2c_eeprom_am_get(CONFIG_EEPROM_BUS_ADDRESS, CONFIG_EEPROM_CHIP_ADDRESS)) diff --git a/board/ti/am335x/board.h b/board/ti/am335x/board.h index 48df914af9..c2962111c1 100644 --- a/board/ti/am335x/board.h +++ b/board/ti/am335x/board.h @@ -93,5 +93,6 @@ void enable_uart3_pin_mux(void); void enable_uart4_pin_mux(void); void enable_uart5_pin_mux(void); void enable_i2c0_pin_mux(void); +void enable_i2c2_pin_mux(void); void enable_board_pin_mux(void); #endif diff --git a/board/ti/am335x/mux.c b/board/ti/am335x/mux.c index 6fb2c009ba..78dc0cca42 100644 --- a/board/ti/am335x/mux.c +++ b/board/ti/am335x/mux.c @@ -124,6 +124,14 @@ static struct module_pin_mux i2c1_pin_mux[] = { {-1}, };
+static struct module_pin_mux i2c2_pin_mux[] = { + {OFFSET(uart1_ctsn), (MODE(3) | RXACTIVE | + PULLUDEN | PULLUP_EN | SLEWCTRL)}, /* I2C_DATA */ + {OFFSET(uart1_rtsn), (MODE(3) | RXACTIVE | + PULLUDEN | PULLUP_EN | SLEWCTRL)}, /* I2C_SCLK */ + {-1}, +}; + static struct module_pin_mux spi0_pin_mux[] = { {OFFSET(spi0_sclk), (MODE(0) | RXACTIVE | PULLUDEN)}, /* SPI0_SCLK */ {OFFSET(spi0_d0), (MODE(0) | RXACTIVE | @@ -308,6 +316,11 @@ void enable_i2c0_pin_mux(void) configure_module_pin_mux(i2c0_pin_mux); }
+void enable_i2c2_pin_mux(void) +{ + configure_module_pin_mux(i2c2_pin_mux); +} + /* * The AM335x GP EVM, if daughter card(s) are connected, can have 8 * different profiles. These profiles determine what peripherals are @@ -367,6 +380,7 @@ void enable_board_pin_mux(void) #else configure_module_pin_mux(mmc1_pin_mux); #endif + configure_module_pin_mux(i2c2_pin_mux); } else if (board_is_gp_evm()) { /* General Purpose EVM */ unsigned short profile = detect_daughter_board_profile(); @@ -411,6 +425,7 @@ void enable_board_pin_mux(void) #else configure_module_pin_mux(mmc1_pin_mux); #endif + configure_module_pin_mux(i2c2_pin_mux); } else if (board_is_pb()) { configure_module_pin_mux(mii1_pin_mux); configure_module_pin_mux(mmc0_pin_mux);

Update the Kconfig and the board file to make the am335x board compatible with cape detection.
Signed-off-by: Kory Maincent kory.maincent@bootlin.com ---
Change Since v1: - Remove CAPE_EEPROM_BUS_NUM from board header
arch/arm/mach-omap2/am33xx/Kconfig | 1 + board/ti/am335x/board.c | 1 + 2 files changed, 2 insertions(+)
diff --git a/arch/arm/mach-omap2/am33xx/Kconfig b/arch/arm/mach-omap2/am33xx/Kconfig index 9a98e8a0a9..11e54cd293 100644 --- a/arch/arm/mach-omap2/am33xx/Kconfig +++ b/arch/arm/mach-omap2/am33xx/Kconfig @@ -34,6 +34,7 @@ config TARGET_AM335X_EVM select DM_GPIO select DM_SERIAL select TI_I2C_BOARD_DETECT + select SUPPORT_EXTENSION_SCAN imply CMD_DM imply SPL_DM imply SPL_DM_SEQ_ALIAS diff --git a/board/ti/am335x/board.c b/board/ti/am335x/board.c index 56cdda856c..eb5cbd3b30 100644 --- a/board/ti/am335x/board.c +++ b/board/ti/am335x/board.c @@ -43,6 +43,7 @@ #include <env_internal.h> #include <watchdog.h> #include "../common/board_detect.h" +#include "../common/cape_detect.h" #include "board.h"
DECLARE_GLOBAL_DATA_PTR;
participants (3)
-
Kory Maincent
-
Köry Maincent
-
Maxime Ripard