u-boot/include/board.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
8  * This uclass encapsulates hardware methods to gather information about a
9  * board or a specific device such as hard-wired GPIOs on GPIO expanders,
10  * read-only data in flash ICs, or similar.
12  * The interface offers functions to read the usual standard data types (bool,
16  * If for example the board had a read-only serial number flash IC, we could
31  * to read the serial number.
36 	 * detect() - Run the hardware info detection procedure for this
40 	 * This operation might take a long time (e.g. read from EEPROM,
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.
54 	 * @val:	Pointer to a buffer that receives the value read.
56 	 * Return: 0 if OK, -ve on error.
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.
65 	 * @val:       Pointer to a buffer that receives the value read.
67 	 * Return: 0 if OK, -ve on error.
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.
76 	 * @size:	The size of the buffer to receive the string data.
77 	 * @val:	Pointer to a buffer that receives the value read.
79 	 * Return: 0 if OK, -ve on error.
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.
100  * @val:	Pointer to a buffer that receives the value read.
102  * Return: 0 if OK, -ve on error.
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.
111  * @val:	Pointer to a buffer that receives the value read.
113  * Return: 0 if OK, -ve on error.
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.
122  * @size:	The size of the buffer to receive the string data.
123  * @val:	Pointer to a buffer that receives the value read.
125  * Return: 0 if OK, -ve on error.
130  * board_get() - Return the board device for the board in question.
131  * @devp: Pointer to structure to receive the board device.
137  * Return: 0 if OK, -ve on error.