u-boot/include/board.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
9  * board or a specific device such as hard-wired GPIOs on GPIO expanders,
10  * read-only data in flash ICs, or similar.
14  * numeric ID (which will usually be defined as a enum in a header file).
16  * If for example the board had a read-only serial number flash IC, we could
21  *	debug("board device not found.");
36 	 * detect() - Run the hardware info detection procedure for this
45 	 * Return: 0 if OK, -ve on error.
50 	 * get_bool() - Read a specific bool data value that describes the
52 	 * @dev:	The board instance to gather the data.
53 	 * @id:		A unique identifier for the bool value to be read.
56 	 * Return: 0 if OK, -ve on error.
58 	int (*get_bool)(struct udevice *dev, int id, bool *val);
61 	 * get_int() - Read a specific int data value that describes the
63 	 * @dev:       The board instance to gather the data.
64 	 * @id:        A unique identifier for the int value to be read.
67 	 * Return: 0 if OK, -ve on error.
69 	int (*get_int)(struct udevice *dev, int id, int *val);
72 	 * get_str() - Read a specific string data value that describes the
74 	 * @dev:	The board instance to gather the data.
75 	 * @id:		A unique identifier for the string value to be read.
79 	 * Return: 0 if OK, -ve on error.
81 	int (*get_str)(struct udevice *dev, int id, size_t size, char *val);
84 #define board_get_ops(dev)	((struct board_ops *)(dev)->driver->ops)
87  * board_detect() - Run the hardware info detection procedure for this device.
91  * Return: 0 if OK, -ve on error.
96  * board_get_bool() - Read a specific bool data value that describes the
98  * @dev:	The board instance to gather the data.
99  * @id:		A unique identifier for the bool value to be read.
102  * Return: 0 if OK, -ve on error.
104 int board_get_bool(struct udevice *dev, int id, bool *val);
107  * board_get_int() - Read a specific int data value that describes the
109  * @dev:	The board instance to gather the data.
110  * @id:		A unique identifier for the int value to be read.
113  * Return: 0 if OK, -ve on error.
115 int board_get_int(struct udevice *dev, int id, int *val);
118  * board_get_str() - Read a specific string data value that describes the
120  * @dev:	The board instance to gather the data.
121  * @id:		A unique identifier for the string value to be read.
125  * Return: 0 if OK, -ve on error.
127 int board_get_str(struct udevice *dev, int id, size_t size, char *val);
130  * board_get() - Return the board device for the board in question.
131  * @devp: Pointer to structure to receive the board device.
133  * Since there can only be at most one board instance, the API can supply a
135  * in board files.
137  * Return: 0 if OK, -ve on error.