board_detect.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Library to support early TI EVM EEPROM handling
  4. *
  5. * Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com
  6. */
  7. #ifndef __BOARD_DETECT_H
  8. #define __BOARD_DETECT_H
  9. /* TI EEPROM MAGIC Header identifier */
  10. #define TI_EEPROM_HEADER_MAGIC 0xEE3355AA
  11. #define TI_DEAD_EEPROM_MAGIC 0xADEAD12C
  12. #define TI_EEPROM_HDR_NAME_LEN 8
  13. #define TI_EEPROM_HDR_REV_LEN 4
  14. #define TI_EEPROM_HDR_SERIAL_LEN 12
  15. #define TI_EEPROM_HDR_CONFIG_LEN 32
  16. #define TI_EEPROM_HDR_NO_OF_MAC_ADDR 3
  17. #define TI_EEPROM_HDR_ETH_ALEN 6
  18. /**
  19. * struct ti_am_eeprom - This structure holds data read in from the
  20. * AM335x, AM437x, AM57xx TI EVM EEPROMs.
  21. * @header: This holds the magic number
  22. * @name: The name of the board
  23. * @version: Board revision
  24. * @serial: Board serial number
  25. * @config: Reserved
  26. * @mac_addr: Any MAC addresses written in the EEPROM
  27. *
  28. * The data is this structure is read from the EEPROM on the board.
  29. * It is used for board detection which is based on name. It is used
  30. * to configure specific TI boards. This allows booting of multiple
  31. * TI boards with a single MLO and u-boot.
  32. */
  33. struct ti_am_eeprom {
  34. unsigned int header;
  35. char name[TI_EEPROM_HDR_NAME_LEN];
  36. char version[TI_EEPROM_HDR_REV_LEN];
  37. char serial[TI_EEPROM_HDR_SERIAL_LEN];
  38. char config[TI_EEPROM_HDR_CONFIG_LEN];
  39. char mac_addr[TI_EEPROM_HDR_NO_OF_MAC_ADDR][TI_EEPROM_HDR_ETH_ALEN];
  40. } __attribute__ ((__packed__));
  41. /* AM6x TI EVM EEPROM Definitions */
  42. #define TI_AM6_EEPROM_RECORD_BOARD_ID 0x01
  43. #define TI_AM6_EEPROM_RECORD_BOARD_INFO 0x10
  44. #define TI_AM6_EEPROM_RECORD_DDR_INFO 0x11
  45. #define TI_AM6_EEPROM_RECORD_DDR_SPD 0x12
  46. #define TI_AM6_EEPROM_RECORD_MAC_INFO 0x13
  47. #define TI_AM6_EEPROM_RECORD_END_LIST 0xFE
  48. /*
  49. * Common header for AM6x TI EVM EEPROM records. Used to encapsulate the config
  50. * EEPROM in its entirety as well as for individual records contained within.
  51. */
  52. struct ti_am6_eeprom_record_header {
  53. u8 id;
  54. u16 len;
  55. } __attribute__ ((__packed__));
  56. /* AM6x TI EVM EEPROM board ID structure */
  57. struct ti_am6_eeprom_record_board_id {
  58. u32 magic_number;
  59. struct ti_am6_eeprom_record_header header;
  60. } __attribute__ ((__packed__));
  61. /* AM6x TI EVM EEPROM board info structure */
  62. #define AM6_EEPROM_HDR_NAME_LEN 16
  63. #define AM6_EEPROM_HDR_VERSION_LEN 2
  64. #define AM6_EEPROM_HDR_PROC_NR_LEN 4
  65. #define AM6_EEPROM_HDR_VARIANT_LEN 2
  66. #define AM6_EEPROM_HDR_PCB_REV_LEN 2
  67. #define AM6_EEPROM_HDR_SCH_BOM_REV_LEN 2
  68. #define AM6_EEPROM_HDR_SW_REV_LEN 2
  69. #define AM6_EEPROM_HDR_VID_LEN 2
  70. #define AM6_EEPROM_HDR_BLD_WK_LEN 2
  71. #define AM6_EEPROM_HDR_BLD_YR_LEN 2
  72. #define AM6_EEPROM_HDR_4P_NR_LEN 6
  73. #define AM6_EEPROM_HDR_SERIAL_LEN 4
  74. struct ti_am6_eeprom_record_board_info {
  75. char name[AM6_EEPROM_HDR_NAME_LEN];
  76. char version[AM6_EEPROM_HDR_VERSION_LEN];
  77. char proc_number[AM6_EEPROM_HDR_PROC_NR_LEN];
  78. char variant[AM6_EEPROM_HDR_VARIANT_LEN];
  79. char pcb_revision[AM6_EEPROM_HDR_PCB_REV_LEN];
  80. char schematic_bom_revision[AM6_EEPROM_HDR_SCH_BOM_REV_LEN];
  81. char software_revision[AM6_EEPROM_HDR_SW_REV_LEN];
  82. char vendor_id[AM6_EEPROM_HDR_VID_LEN];
  83. char build_week[AM6_EEPROM_HDR_BLD_WK_LEN];
  84. char build_year[AM6_EEPROM_HDR_BLD_YR_LEN];
  85. char board_4p_number[AM6_EEPROM_HDR_4P_NR_LEN];
  86. char serial[AM6_EEPROM_HDR_SERIAL_LEN];
  87. } __attribute__ ((__packed__));
  88. /* Memory location to keep a copy of the AM6 board info record */
  89. #define TI_AM6_EEPROM_BD_INFO_DATA ((struct ti_am6_eeprom_record_board_info *) \
  90. TI_SRAM_SCRATCH_BOARD_EEPROM_START)
  91. /* AM6x TI EVM EEPROM DDR info structure */
  92. #define TI_AM6_EEPROM_DDR_CTRL_INSTANCE_MASK GENMASK(1, 0)
  93. #define TI_AM6_EEPROM_DDR_CTRL_INSTANCE_SHIFT 0
  94. #define TI_AM6_EEPROM_DDR_CTRL_SPD_DATA_LOC_MASK GENMASK(3, 2)
  95. #define TI_AM6_EEPROM_DDR_CTRL_SPD_DATA_LOC_NA (0 << 2)
  96. #define TI_AM6_EEPROM_DDR_CTRL_SPD_DATA_LOC_BOARDID (2 << 2)
  97. #define TI_AM6_EEPROM_DDR_CTRL_SPD_DATA_LOC_I2C51 (3 << 2)
  98. #define TI_AM6_EEPROM_DDR_CTRL_MEM_TYPE_MASK GENMASK(5, 4)
  99. #define TI_AM6_EEPROM_DDR_CTRL_MEM_TYPE_DDR3 (0 << 4)
  100. #define TI_AM6_EEPROM_DDR_CTRL_MEM_TYPE_DDR4 (1 << 4)
  101. #define TI_AM6_EEPROM_DDR_CTRL_MEM_TYPE_LPDDR4 (2 << 4)
  102. #define TI_AM6_EEPROM_DDR_CTRL_IF_DATA_WIDTH_MASK GENMASK(7, 6)
  103. #define TI_AM6_EEPROM_DDR_CTRL_IF_DATA_WIDTH_16 (0 << 6)
  104. #define TI_AM6_EEPROM_DDR_CTRL_IF_DATA_WIDTH_32 (1 << 6)
  105. #define TI_AM6_EEPROM_DDR_CTRL_IF_DATA_WIDTH_64 (2 << 6)
  106. #define TI_AM6_EEPROM_DDR_CTRL_DEV_DATA_WIDTH_MASK GENMASK(9, 8)
  107. #define TI_AM6_EEPROM_DDR_CTRL_DEV_DATA_WIDTH_8 (0 << 8)
  108. #define TI_AM6_EEPROM_DDR_CTRL_DEV_DATA_WIDTH_16 (1 << 8)
  109. #define TI_AM6_EEPROM_DDR_CTRL_DEV_DATA_WIDTH_32 (2 << 8)
  110. #define TI_AM6_EEPROM_DDR_CTRL_RANKS_2 BIT(10)
  111. #define TI_AM6_EEPROM_DDR_CTRL_DENS_MASK GENMASK(13, 11)
  112. #define TI_AM6_EEPROM_DDR_CTRL_DENS_1GB (0 << 11)
  113. #define TI_AM6_EEPROM_DDR_CTRL_DENS_2GB (1 << 11)
  114. #define TI_AM6_EEPROM_DDR_CTRL_DENS_4GB (2 << 11)
  115. #define TI_AM6_EEPROM_DDR_CTRL_DENS_8GB (3 << 11)
  116. #define TI_AM6_EEPROM_DDR_CTRL_DENS_12GB (4 << 11)
  117. #define TI_AM6_EEPROM_DDR_CTRL_DENS_16GB (5 << 11)
  118. #define TI_AM6_EEPROM_DDR_CTRL_DENS_24GB (6 << 11)
  119. #define TI_AM6_EEPROM_DDR_CTRL_DENS_32GB (7 << 11)
  120. #define TI_AM6_EEPROM_DDR_CTRL_ECC BIT(14)
  121. struct ti_am6_eeprom_record_ddr_info {
  122. u16 ddr_control;
  123. } __attribute__ ((__packed__));
  124. /* AM6x TI EVM EEPROM DDR SPD structure */
  125. #define TI_AM6_EEPROM_DDR_SPD_INSTANCE_MASK GENMASK(1, 0)
  126. #define TI_AM6_EEPROM_DDR_SPD_INSTANCE_SHIFT 0
  127. #define TI_AM6_EEPROM_DDR_SPD_MEM_TYPE_MASK GENMASK(4, 3)
  128. #define TI_AM6_EEPROM_DDR_SPD_MEM_TYPE_DDR3 (0 << 3)
  129. #define TI_AM6_EEPROM_DDR_SPD_MEM_TYPE_DDR4 (1 << 3)
  130. #define TI_AM6_EEPROM_DDR_SPD_MEM_TYPE_LPDDR4 (2 << 3)
  131. #define TI_AM6_EEPROM_DDR_SPD_DATA_LEN 512
  132. struct ti_am6_eeprom_record_ddr_spd {
  133. u16 spd_control;
  134. u8 data[TI_AM6_EEPROM_DDR_SPD_DATA_LEN];
  135. } __attribute__ ((__packed__));
  136. /* AM6x TI EVM EEPROM MAC info structure */
  137. #define TI_AM6_EEPROM_MAC_INFO_INSTANCE_MASK GENMASK(2, 0)
  138. #define TI_AM6_EEPROM_MAC_INFO_INSTANCE_SHIFT 0
  139. #define TI_AM6_EEPROM_MAC_ADDR_COUNT_MASK GENMASK(7, 3)
  140. #define TI_AM6_EEPROM_MAC_ADDR_COUNT_SHIFT 3
  141. #define TI_AM6_EEPROM_MAC_ADDR_MAX_COUNT 32
  142. struct ti_am6_eeprom_record_mac_info {
  143. u16 mac_control;
  144. u8 mac_addr[TI_AM6_EEPROM_MAC_ADDR_MAX_COUNT][TI_EEPROM_HDR_ETH_ALEN];
  145. } __attribute__ ((__packed__));
  146. struct ti_am6_eeprom_record {
  147. struct ti_am6_eeprom_record_header header;
  148. union {
  149. struct ti_am6_eeprom_record_board_info board_info;
  150. struct ti_am6_eeprom_record_ddr_info ddr_info;
  151. struct ti_am6_eeprom_record_ddr_spd ddr_spd;
  152. struct ti_am6_eeprom_record_mac_info mac_info;
  153. } data;
  154. } __attribute__ ((__packed__));
  155. /* DRA7 EEPROM MAGIC Header identifier */
  156. #define DRA7_EEPROM_HEADER_MAGIC 0xAA5533EE
  157. #define DRA7_EEPROM_HDR_NAME_LEN 16
  158. #define DRA7_EEPROM_HDR_CONFIG_LEN 4
  159. /**
  160. * struct dra7_eeprom - This structure holds data read in from the DRA7 EVM
  161. * EEPROMs.
  162. * @header: This holds the magic number
  163. * @name: The name of the board
  164. * @version_major: Board major version
  165. * @version_minor: Board minor version
  166. * @config: Board specific config options
  167. * @emif1_size: Size of DDR attached to EMIF1
  168. * @emif2_size: Size of DDR attached to EMIF2
  169. *
  170. * The data is this structure is read from the EEPROM on the board.
  171. * It is used for board detection which is based on name. It is used
  172. * to configure specific DRA7 boards. This allows booting of multiple
  173. * DRA7 boards with a single MLO and u-boot.
  174. */
  175. struct dra7_eeprom {
  176. u32 header;
  177. char name[DRA7_EEPROM_HDR_NAME_LEN];
  178. u16 version_major;
  179. u16 version_minor;
  180. char config[DRA7_EEPROM_HDR_CONFIG_LEN];
  181. u32 emif1_size;
  182. u32 emif2_size;
  183. } __attribute__ ((__packed__));
  184. /**
  185. * struct ti_common_eeprom - Null terminated, usable EEPROM contents.
  186. * header: Magic number
  187. * @name: NULL terminated name
  188. * @version: NULL terminated version
  189. * @serial: NULL terminated serial number
  190. * @config: NULL terminated Board specific config options
  191. * @mac_addr: MAC addresses
  192. * @emif1_size: Size of the ddr available on emif1
  193. * @emif2_size: Size of the ddr available on emif2
  194. */
  195. struct ti_common_eeprom {
  196. u32 header;
  197. char name[TI_EEPROM_HDR_NAME_LEN + 1];
  198. char version[TI_EEPROM_HDR_REV_LEN + 1];
  199. char serial[TI_EEPROM_HDR_SERIAL_LEN + 1];
  200. char config[TI_EEPROM_HDR_CONFIG_LEN + 1];
  201. char mac_addr[TI_EEPROM_HDR_NO_OF_MAC_ADDR][TI_EEPROM_HDR_ETH_ALEN];
  202. u64 emif1_size;
  203. u64 emif2_size;
  204. };
  205. #define TI_EEPROM_DATA ((struct ti_common_eeprom *)\
  206. TI_SRAM_SCRATCH_BOARD_EEPROM_START)
  207. /*
  208. * Maximum number of Ethernet MAC addresses extracted from the AM6x on-board
  209. * EEPROM during the initial probe and carried forward in SRAM.
  210. */
  211. #define AM6_EEPROM_HDR_NO_OF_MAC_ADDR 8
  212. /**
  213. * struct ti_am6_eeprom - Null terminated, usable EEPROM contents, as extracted
  214. * from the AM6 on-board EEPROM. Note that we only carry a subset of data
  215. * at this time to be considerate about memory consumption.
  216. * @header: Magic number for data validity indication
  217. * @name: NULL terminated name
  218. * @version: NULL terminated version
  219. * @software_revision: NULL terminated software revision
  220. * @serial: Board serial number
  221. * @mac_addr_cnt: Number of MAC addresses stored in this object
  222. * @mac_addr: MAC addresses
  223. */
  224. struct ti_am6_eeprom {
  225. u32 header;
  226. char name[AM6_EEPROM_HDR_NAME_LEN + 1];
  227. char version[AM6_EEPROM_HDR_VERSION_LEN + 1];
  228. char software_revision[AM6_EEPROM_HDR_SW_REV_LEN + 1];
  229. char serial[AM6_EEPROM_HDR_SERIAL_LEN + 1];
  230. u8 mac_addr_cnt;
  231. char mac_addr[AM6_EEPROM_HDR_NO_OF_MAC_ADDR][TI_EEPROM_HDR_ETH_ALEN];
  232. };
  233. #define TI_AM6_EEPROM_DATA ((struct ti_am6_eeprom *) \
  234. TI_SRAM_SCRATCH_BOARD_EEPROM_START)
  235. /**
  236. * ti_i2c_eeprom_am_get() - Consolidated eeprom data collection for AM* TI EVMs
  237. * @bus_addr: I2C bus address
  238. * @dev_addr: I2C slave address
  239. *
  240. * ep in SRAM is populated by the this AM generic function that consolidates
  241. * the basic initialization logic common across all AM* platforms.
  242. */
  243. int ti_i2c_eeprom_am_get(int bus_addr, int dev_addr);
  244. /**
  245. * ti_i2c_eeprom_dra7_get() - Consolidated eeprom data for DRA7 TI EVMs
  246. * @bus_addr: I2C bus address
  247. * @dev_addr: I2C slave address
  248. */
  249. int ti_i2c_eeprom_dra7_get(int bus_addr, int dev_addr);
  250. /**
  251. * ti_i2c_eeprom_am6_get() - Consolidated eeprom data for AM6x TI EVMs and
  252. * associated daughter cards, parsed into user-
  253. * provided data structures
  254. * @bus_addr: I2C bus address
  255. * @dev_addr: I2C slave address
  256. * @ep: Pointer to structure receiving AM6-specific header data
  257. * @mac_addr: Pointer to memory receiving parsed MAC addresses. May be
  258. * NULL to skip MAC parsing.
  259. * @mac_addr_max_cnt: Maximum number of MAC addresses that can be stored into
  260. * mac_addr. May be NULL to skip MAC parsing.
  261. * @mac_addr_cnt: Pointer to a location returning how many MAC addressed got
  262. * actually parsed.
  263. */
  264. int __maybe_unused ti_i2c_eeprom_am6_get(int bus_addr, int dev_addr,
  265. struct ti_am6_eeprom *ep,
  266. char **mac_addr,
  267. u8 mac_addr_max_cnt,
  268. u8 *mac_addr_cnt);
  269. /**
  270. * ti_i2c_eeprom_am6_get_base() - Consolidated eeprom data for AM6x TI EVMs
  271. * @bus_addr: I2C bus address
  272. * @dev_addr: I2C slave address
  273. */
  274. int __maybe_unused ti_i2c_eeprom_am6_get_base(int bus_addr, int dev_addr);
  275. /**
  276. * board_ti_is() - Board detection logic for TI EVMs
  277. * @name_tag: Tag used in eeprom for the board
  278. *
  279. * Return: false if board information does not match OR eeprom wasn't read.
  280. * true otherwise
  281. */
  282. bool board_ti_is(char *name_tag);
  283. /**
  284. * board_ti_rev_is() - Compare board revision for TI EVMs
  285. * @rev_tag: Revision tag to check in eeprom
  286. * @cmp_len: How many chars to compare?
  287. *
  288. * NOTE: revision information is often messed up (hence the str len match) :(
  289. *
  290. * Return: false if board information does not match OR eeprom wasn't read.
  291. * true otherwise
  292. */
  293. bool board_ti_rev_is(char *rev_tag, int cmp_len);
  294. /**
  295. * board_ti_get_rev() - Get board revision for TI EVMs
  296. *
  297. * Return: Empty string if eeprom wasn't read.
  298. * Board revision otherwise
  299. */
  300. char *board_ti_get_rev(void);
  301. /**
  302. * board_ti_get_config() - Get board config for TI EVMs
  303. *
  304. * Return: Empty string if eeprom wasn't read.
  305. * Board config otherwise
  306. */
  307. char *board_ti_get_config(void);
  308. /**
  309. * board_ti_get_name() - Get board name for TI EVMs
  310. *
  311. * Return: Empty string if eeprom wasn't read.
  312. * Board name otherwise
  313. */
  314. char *board_ti_get_name(void);
  315. /**
  316. * board_ti_get_eth_mac_addr() - Get Ethernet MAC address from EEPROM MAC list
  317. * @index: 0 based index within the list of MAC addresses
  318. * @mac_addr: MAC address contained at the index is returned here
  319. *
  320. * Does not sanity check the mac_addr. Whatever is stored in EEPROM is returned.
  321. */
  322. void board_ti_get_eth_mac_addr(int index, u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN]);
  323. /**
  324. * board_ti_get_emif1_size() - Get size of the DDR on emif1 for TI EVMs
  325. *
  326. * Return: NULL if eeprom wasn't read or emif1_size is not available.
  327. */
  328. u64 board_ti_get_emif1_size(void);
  329. /**
  330. * board_ti_get_emif2_size() - Get size of the DDR on emif2 for TI EVMs
  331. *
  332. * Return: NULL if eeprom wasn't read or emif2_size is not available.
  333. */
  334. u64 board_ti_get_emif2_size(void);
  335. /**
  336. * set_board_info_env() - Setup commonly used board information environment vars
  337. * @name: Name of the board
  338. *
  339. * If name is NULL, default_name is used.
  340. */
  341. void set_board_info_env(char *name);
  342. /**
  343. * set_board_info_env_am6() - Setup commonly used board information environment
  344. * vars for AM6-type boards
  345. * @name: Name of the board
  346. *
  347. * If name is NULL, default_name is used.
  348. */
  349. void set_board_info_env_am6(char *name);
  350. /**
  351. * board_ti_set_ethaddr- Sets the ethaddr environment from EEPROM
  352. * @index: The first eth<index>addr environment variable to set
  353. *
  354. * EEPROM should be already read before calling this function.
  355. * The EEPROM contains 2 MAC addresses which define the MAC address
  356. * range (i.e. first and last MAC address).
  357. * This function sets the ethaddr environment variable for all
  358. * the available MAC addresses starting from eth<index>addr.
  359. */
  360. void board_ti_set_ethaddr(int index);
  361. /**
  362. * board_ti_am6_set_ethaddr- Sets the ethaddr environment from EEPROM
  363. * @index: The first eth<index>addr environment variable to set
  364. * @count: The number of MAC addresses to process
  365. *
  366. * EEPROM should be already read before calling this function. The EEPROM
  367. * contains n dedicated MAC addresses. This function sets the ethaddr
  368. * environment variable for all the available MAC addresses starting
  369. * from eth<index>addr.
  370. */
  371. void board_ti_am6_set_ethaddr(int index, int count);
  372. /**
  373. * board_ti_was_eeprom_read() - Check to see if the eeprom contents have been read
  374. *
  375. * This function is useful to determine if the eeprom has already been read and
  376. * its contents have already been loaded into memory. It utiltzes the magic
  377. * number that the header value is set to upon successful eeprom read.
  378. */
  379. bool board_ti_was_eeprom_read(void);
  380. /**
  381. * ti_i2c_eeprom_am_set() - Setup the eeprom data with predefined values
  382. * @name: Name of the board
  383. * @rev: Revision of the board
  384. *
  385. * In some cases such as in RTC-only mode, we are able to skip reading eeprom
  386. * and wasting i2c based initialization time by using predefined flags for
  387. * detecting what platform we are booting on. For those platforms, provide
  388. * a handy function to pre-program information.
  389. *
  390. * NOTE: many eeprom information such as serial number, mac address etc is not
  391. * available.
  392. *
  393. * Return: 0 if all went fine, else return error.
  394. */
  395. int ti_i2c_eeprom_am_set(const char *name, const char *rev);
  396. #endif /* __BOARD_DETECT_H */