1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Library to support early TI EVM EEPROM handling
5 * Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com
8 #ifndef __BOARD_DETECT_H
9 #define __BOARD_DETECT_H
11 /* TI EEPROM MAGIC Header identifier */
12 #define TI_EEPROM_HEADER_MAGIC 0xEE3355AA
13 #define TI_DEAD_EEPROM_MAGIC 0xADEAD12C
15 #define TI_EEPROM_HDR_NAME_LEN 8
16 #define TI_EEPROM_HDR_REV_LEN 4
17 #define TI_EEPROM_HDR_SERIAL_LEN 12
18 #define TI_EEPROM_HDR_CONFIG_LEN 32
19 #define TI_EEPROM_HDR_NO_OF_MAC_ADDR 3
20 #define TI_EEPROM_HDR_ETH_ALEN 6
23 * struct ti_am_eeprom - This structure holds data read in from the
24 * AM335x, AM437x, AM57xx TI EVM EEPROMs.
25 * @header: This holds the magic number
26 * @name: The name of the board
27 * @version: Board revision
28 * @serial: Board serial number
30 * @mac_addr: Any MAC addresses written in the EEPROM
32 * The data is this structure is read from the EEPROM on the board.
33 * It is used for board detection which is based on name. It is used
34 * to configure specific TI boards. This allows booting of multiple
35 * TI boards with a single MLO and u-boot.
39 char name[TI_EEPROM_HDR_NAME_LEN];
40 char version[TI_EEPROM_HDR_REV_LEN];
41 char serial[TI_EEPROM_HDR_SERIAL_LEN];
42 char config[TI_EEPROM_HDR_CONFIG_LEN];
43 char mac_addr[TI_EEPROM_HDR_NO_OF_MAC_ADDR][TI_EEPROM_HDR_ETH_ALEN];
44 } __attribute__ ((__packed__));
46 /* DRA7 EEPROM MAGIC Header identifier */
47 #define DRA7_EEPROM_HEADER_MAGIC 0xAA5533EE
48 #define DRA7_EEPROM_HDR_NAME_LEN 16
49 #define DRA7_EEPROM_HDR_CONFIG_LEN 4
52 * struct dra7_eeprom - This structure holds data read in from the DRA7 EVM
54 * @header: This holds the magic number
55 * @name: The name of the board
56 * @version_major: Board major version
57 * @version_minor: Board minor version
58 * @config: Board specific config options
59 * @emif1_size: Size of DDR attached to EMIF1
60 * @emif2_size: Size of DDR attached to EMIF2
62 * The data is this structure is read from the EEPROM on the board.
63 * It is used for board detection which is based on name. It is used
64 * to configure specific DRA7 boards. This allows booting of multiple
65 * DRA7 boards with a single MLO and u-boot.
69 char name[DRA7_EEPROM_HDR_NAME_LEN];
72 char config[DRA7_EEPROM_HDR_CONFIG_LEN];
75 } __attribute__ ((__packed__));
78 * struct ti_common_eeprom - Null terminated, usable EEPROM contents.
79 * header: Magic number
80 * @name: NULL terminated name
81 * @version: NULL terminated version
82 * @serial: NULL terminated serial number
83 * @config: NULL terminated Board specific config options
84 * @mac_addr: MAC addresses
85 * @emif1_size: Size of the ddr available on emif1
86 * @emif2_size: Size of the ddr available on emif2
88 struct ti_common_eeprom {
90 char name[TI_EEPROM_HDR_NAME_LEN + 1];
91 char version[TI_EEPROM_HDR_REV_LEN + 1];
92 char serial[TI_EEPROM_HDR_SERIAL_LEN + 1];
93 char config[TI_EEPROM_HDR_CONFIG_LEN + 1];
94 char mac_addr[TI_EEPROM_HDR_NO_OF_MAC_ADDR][TI_EEPROM_HDR_ETH_ALEN];
99 #define TI_EEPROM_DATA ((struct ti_common_eeprom *)\
100 TI_SRAM_SCRATCH_BOARD_EEPROM_START)
103 * ti_i2c_eeprom_am_get() - Consolidated eeprom data collection for AM* TI EVMs
104 * @bus_addr: I2C bus address
105 * @dev_addr: I2C slave address
107 * ep in SRAM is populated by the this AM generic function that consolidates
108 * the basic initialization logic common across all AM* platforms.
110 int ti_i2c_eeprom_am_get(int bus_addr, int dev_addr);
113 * ti_i2c_eeprom_dra7_get() - Consolidated eeprom data for DRA7 TI EVMs
114 * @bus_addr: I2C bus address
115 * @dev_addr: I2C slave address
117 int ti_i2c_eeprom_dra7_get(int bus_addr, int dev_addr);
120 * board_ti_is() - Board detection logic for TI EVMs
121 * @name_tag: Tag used in eeprom for the board
123 * Return: false if board information does not match OR eeprom wasn't read.
126 bool board_ti_is(char *name_tag);
129 * board_ti_rev_is() - Compare board revision for TI EVMs
130 * @rev_tag: Revision tag to check in eeprom
131 * @cmp_len: How many chars to compare?
133 * NOTE: revision information is often messed up (hence the str len match) :(
135 * Return: false if board information does not match OR eeprom wasn't read.
138 bool board_ti_rev_is(char *rev_tag, int cmp_len);
141 * board_ti_get_rev() - Get board revision for TI EVMs
143 * Return: Empty string if eeprom wasn't read.
144 * Board revision otherwise
146 char *board_ti_get_rev(void);
149 * board_ti_get_config() - Get board config for TI EVMs
151 * Return: Empty string if eeprom wasn't read.
152 * Board config otherwise
154 char *board_ti_get_config(void);
157 * board_ti_get_name() - Get board name for TI EVMs
159 * Return: Empty string if eeprom wasn't read.
160 * Board name otherwise
162 char *board_ti_get_name(void);
165 * board_ti_get_eth_mac_addr() - Get Ethernet MAC address from EEPROM MAC list
166 * @index: 0 based index within the list of MAC addresses
167 * @mac_addr: MAC address contained at the index is returned here
169 * Does not sanity check the mac_addr. Whatever is stored in EEPROM is returned.
171 void board_ti_get_eth_mac_addr(int index, u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN]);
174 * board_ti_get_emif1_size() - Get size of the DDR on emif1 for TI EVMs
176 * Return: NULL if eeprom wasn't read or emif1_size is not available.
178 u64 board_ti_get_emif1_size(void);
181 * board_ti_get_emif2_size() - Get size of the DDR on emif2 for TI EVMs
183 * Return: NULL if eeprom wasn't read or emif2_size is not available.
185 u64 board_ti_get_emif2_size(void);
188 * set_board_info_env() - Setup commonly used board information environment vars
189 * @name: Name of the board
191 * If name is NULL, default_name is used.
193 void set_board_info_env(char *name);
196 * board_ti_set_ethaddr- Sets the ethaddr environment from EEPROM
197 * @index: The first eth<index>addr environment variable to set
199 * EEPROM should be already read before calling this function.
200 * The EEPROM contains 2 MAC addresses which define the MAC address
201 * range (i.e. first and last MAC address).
202 * This function sets the ethaddr environment variable for all
203 * the available MAC addresses starting from eth<index>addr.
205 void board_ti_set_ethaddr(int index);
208 * board_ti_was_eeprom_read() - Check to see if the eeprom contents have been read
210 * This function is useful to determine if the eeprom has already been read and
211 * its contents have already been loaded into memory. It utiltzes the magic
212 * number that the header value is set to upon successful eeprom read.
214 bool board_ti_was_eeprom_read(void);
217 * ti_i2c_eeprom_am_set() - Setup the eeprom data with predefined values
218 * @name: Name of the board
219 * @rev: Revision of the board
221 * In some cases such as in RTC-only mode, we are able to skip reading eeprom
222 * and wasting i2c based initialization time by using predefined flags for
223 * detecting what platform we are booting on. For those platforms, provide
224 * a handy function to pre-program information.
226 * NOTE: many eeprom information such as serial number, mac address etc is not
229 * Return: 0 if all went fine, else return error.
231 int ti_i2c_eeprom_am_set(const char *name, const char *rev);
233 #endif /* __BOARD_DETECT_H */