Documentation: Fix sphinx configuration
[coreboot.git] / src / include / boardid.h
blobdfa9532df0b05d1383f430db7da452ca7d12d2a2
1 /* SPDX-License-Identifier: GPL-2.0-only */
3 #ifndef __INCLUDE_BOARDID_H__
4 #define __INCLUDE_BOARDID_H__
6 #include <stdint.h>
8 #define UNDEFINED_STRAPPING_ID (~0)
10 #define BOARD_ID_UNKNOWN ~((uint32_t)0) /* unsigned equivalent to -1 */
11 #define BOARD_ID_INIT ~((uint32_t)1) /* unsigned equivalent to -2 */
12 /**
13 * board_id() - Get the board version
15 * Return: board version on success, BOARD_ID_UNKNOWN on failure/error.
17 * This function is used to get the mainboard version.
19 uint32_t board_id(void); /* differentiates revisions */
20 uint32_t ram_code(void); /* identifies installed DRAM modules */
21 uint32_t sku_id(void); /* differentiates other optional components */
23 #endif /* __INCLUDE_BOARDID_H__ */