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/
11 #include <asm/arch/hardware.h>
12 #include <asm/omap_common.h>
13 #include <dm/uclass.h>
16 #include "board_detect.h"
18 #if !defined(CONFIG_DM_I2C)
20 * ti_i2c_eeprom_init - Initialize an i2c bus and probe for a device
21 * @i2c_bus: i2c bus number to initialize
22 * @dev_addr: Device address to probe for
24 * Return: 0 on success or corresponding error on failure.
26 static int __maybe_unused ti_i2c_eeprom_init(int i2c_bus, int dev_addr)
31 rc = i2c_set_bus_num(i2c_bus);
36 return i2c_probe(dev_addr);
40 * ti_i2c_eeprom_read - Read data from an EEPROM
41 * @dev_addr: The device address of the EEPROM
42 * @offset: Offset to start reading in the EEPROM
43 * @ep: Pointer to a buffer to read into
44 * @epsize: Size of buffer
46 * Return: 0 on success or corresponding result of i2c_read
48 static int __maybe_unused ti_i2c_eeprom_read(int dev_addr, int offset,
49 uchar *ep, int epsize)
51 return i2c_read(dev_addr, offset, 2, ep, epsize);
56 * ti_eeprom_string_cleanup() - Handle eeprom programming errors
57 * @s: eeprom string (should be NULL terminated)
59 * Some Board manufacturers do not add a NULL termination at the
60 * end of string, instead some binary information is kludged in, hence
61 * convert the string to just printable characters of ASCII chart.
63 static void __maybe_unused ti_eeprom_string_cleanup(char *s)
68 for (i = 0; i < l; i++, s++)
69 if (*s < ' ' || *s > '~') {
75 __weak void gpi2c_init(void)
79 static int __maybe_unused ti_i2c_eeprom_get(int bus_addr, int dev_addr,
80 u32 header, u32 size, uint8_t *ep)
85 #if defined(CONFIG_DM_I2C)
89 rc = uclass_get_device_by_seq(UCLASS_I2C, bus_addr, &bus);
92 rc = i2c_get_chip(bus, dev_addr, 1, &dev);
97 * Read the header first then only read the other contents.
99 rc = i2c_set_chip_offset_len(dev, 2);
103 rc = dm_i2c_read(dev, 0, (uint8_t *)&hdr_read, 4);
107 /* Corrupted data??? */
108 if (hdr_read != header) {
109 rc = dm_i2c_read(dev, 0, (uint8_t *)&hdr_read, 4);
111 * read the eeprom header using i2c again, but use only a
112 * 1 byte address (some legacy boards need this..)
115 rc = i2c_set_chip_offset_len(dev, 1);
119 rc = dm_i2c_read(dev, 0, (uint8_t *)&hdr_read, 4);
124 if (hdr_read != header)
127 rc = dm_i2c_read(dev, 0, ep, size);
134 rc = ti_i2c_eeprom_init(bus_addr, dev_addr);
139 * Read the header first then only read the other contents.
143 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 4);
147 /* Corrupted data??? */
148 if (hdr_read != header) {
149 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 4);
151 * read the eeprom header using i2c again, but use only a
152 * 1 byte address (some legacy boards need this..)
156 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read,
162 if (hdr_read != header)
165 rc = i2c_read(dev_addr, 0x0, byte, ep, size);
172 int __maybe_unused ti_i2c_eeprom_am_set(const char *name, const char *rev)
174 struct ti_common_eeprom *ep;
180 if (ep->header == TI_EEPROM_HEADER_MAGIC)
183 /* Set to 0 all fields */
184 memset(ep, 0, sizeof(*ep));
185 strncpy(ep->name, name, TI_EEPROM_HDR_NAME_LEN);
186 strncpy(ep->version, rev, TI_EEPROM_HDR_REV_LEN);
187 /* Some dummy serial number to identify the platform */
188 strncpy(ep->serial, "0000", TI_EEPROM_HDR_SERIAL_LEN);
189 /* Mark it with a valid header */
190 ep->header = TI_EEPROM_HEADER_MAGIC;
196 int __maybe_unused ti_i2c_eeprom_am_get(int bus_addr, int dev_addr)
199 struct ti_am_eeprom am_ep;
200 struct ti_common_eeprom *ep;
203 #ifndef CONFIG_SPL_BUILD
204 if (ep->header == TI_EEPROM_HEADER_MAGIC)
205 return 0; /* EEPROM has already been read */
208 /* Initialize with a known bad marker for i2c fails.. */
209 ep->header = TI_DEAD_EEPROM_MAGIC;
211 ep->version[0] = 0x0;
215 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, TI_EEPROM_HEADER_MAGIC,
216 sizeof(am_ep), (uint8_t *)&am_ep);
220 ep->header = am_ep.header;
221 strlcpy(ep->name, am_ep.name, TI_EEPROM_HDR_NAME_LEN + 1);
222 ti_eeprom_string_cleanup(ep->name);
224 /* BeagleBone Green '1' eeprom, board_rev: 0x1a 0x00 0x00 0x00 */
225 if (am_ep.version[0] == 0x1a && am_ep.version[1] == 0x00 &&
226 am_ep.version[2] == 0x00 && am_ep.version[3] == 0x00)
227 strlcpy(ep->version, "BBG1", TI_EEPROM_HDR_REV_LEN + 1);
229 strlcpy(ep->version, am_ep.version, TI_EEPROM_HDR_REV_LEN + 1);
230 ti_eeprom_string_cleanup(ep->version);
231 strlcpy(ep->serial, am_ep.serial, TI_EEPROM_HDR_SERIAL_LEN + 1);
232 ti_eeprom_string_cleanup(ep->serial);
233 strlcpy(ep->config, am_ep.config, TI_EEPROM_HDR_CONFIG_LEN + 1);
234 ti_eeprom_string_cleanup(ep->config);
236 memcpy(ep->mac_addr, am_ep.mac_addr,
237 TI_EEPROM_HDR_NO_OF_MAC_ADDR * TI_EEPROM_HDR_ETH_ALEN);
242 int __maybe_unused ti_i2c_eeprom_dra7_get(int bus_addr, int dev_addr)
245 struct dra7_eeprom dra7_ep;
246 struct ti_common_eeprom *ep;
249 #ifndef CONFIG_SPL_BUILD
250 if (ep->header == DRA7_EEPROM_HEADER_MAGIC)
251 return 0; /* EEPROM has already been read */
254 /* Initialize with a known bad marker for i2c fails.. */
255 ep->header = TI_DEAD_EEPROM_MAGIC;
257 ep->version[0] = 0x0;
263 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, DRA7_EEPROM_HEADER_MAGIC,
264 sizeof(dra7_ep), (uint8_t *)&dra7_ep);
268 ep->header = dra7_ep.header;
269 strlcpy(ep->name, dra7_ep.name, TI_EEPROM_HDR_NAME_LEN + 1);
270 ti_eeprom_string_cleanup(ep->name);
272 offset = dra7_ep.version_major - 1;
274 /* Rev F is skipped */
277 snprintf(ep->version, TI_EEPROM_HDR_REV_LEN + 1, "%c.%d",
278 'A' + offset, dra7_ep.version_minor);
279 ti_eeprom_string_cleanup(ep->version);
280 ep->emif1_size = (u64)dra7_ep.emif1_size;
281 ep->emif2_size = (u64)dra7_ep.emif2_size;
282 strlcpy(ep->config, dra7_ep.config, TI_EEPROM_HDR_CONFIG_LEN + 1);
283 ti_eeprom_string_cleanup(ep->config);
288 static int ti_i2c_eeprom_am6_parse_record(struct ti_am6_eeprom_record *record,
289 struct ti_am6_eeprom *ep,
294 switch (record->header.id) {
295 case TI_AM6_EEPROM_RECORD_BOARD_INFO:
296 if (record->header.len != sizeof(record->data.board_info))
302 /* Populate (and clean, if needed) the board name */
303 strlcpy(ep->name, record->data.board_info.name,
305 ti_eeprom_string_cleanup(ep->name);
307 /* Populate selected other fields from the board info record */
308 strlcpy(ep->version, record->data.board_info.version,
309 sizeof(ep->version));
310 strlcpy(ep->software_revision,
311 record->data.board_info.software_revision,
312 sizeof(ep->software_revision));
313 strlcpy(ep->serial, record->data.board_info.serial,
316 case TI_AM6_EEPROM_RECORD_MAC_INFO:
317 if (record->header.len != sizeof(record->data.mac_info))
320 if (!mac_addr || !mac_addr_max_cnt)
323 *mac_addr_cnt = ((record->data.mac_info.mac_control &
324 TI_AM6_EEPROM_MAC_ADDR_COUNT_MASK) >>
325 TI_AM6_EEPROM_MAC_ADDR_COUNT_SHIFT) + 1;
328 * The EEPROM can (but may not) hold a very large amount
329 * of MAC addresses, by far exceeding what we want/can store
330 * in the common memory array, so only grab what we can fit.
331 * Note that a value of 0 means 1 MAC address, and so on.
333 *mac_addr_cnt = min(*mac_addr_cnt, mac_addr_max_cnt);
335 memcpy(mac_addr, record->data.mac_info.mac_addr,
336 *mac_addr_cnt * TI_EEPROM_HDR_ETH_ALEN);
339 /* Illegal value... Fall through... */
341 /* Illegal value... Something went horribly wrong... */
344 pr_warn("%s: Ignoring record id %u\n", __func__,
351 int __maybe_unused ti_i2c_eeprom_am6_get(int bus_addr, int dev_addr,
352 struct ti_am6_eeprom *ep,
359 unsigned int eeprom_addr;
360 struct ti_am6_eeprom_record_board_id board_id;
361 struct ti_am6_eeprom_record record;
364 /* Initialize with a known bad marker for i2c fails.. */
365 memset(ep, 0, sizeof(*ep));
366 ep->header = TI_DEAD_EEPROM_MAGIC;
368 /* Read the board ID record which is always the first EEPROM record */
369 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, TI_EEPROM_HEADER_MAGIC,
370 sizeof(board_id), (uint8_t *)&board_id);
374 if (board_id.header.id != TI_AM6_EEPROM_RECORD_BOARD_ID) {
375 pr_err("%s: Invalid board ID record!\n", __func__);
379 /* Establish DM handle to board config EEPROM */
380 rc = uclass_get_device_by_seq(UCLASS_I2C, bus_addr, &bus);
383 rc = i2c_get_chip(bus, dev_addr, 1, &dev);
387 ep->header = TI_EEPROM_HEADER_MAGIC;
389 /* Ready to parse TLV structure. Initialize variables... */
393 * After the all-encompassing board ID record all other records follow
394 * a TLV-type scheme. Point to the first such record and then start
395 * parsing those one by one.
397 eeprom_addr = sizeof(board_id);
400 rc = dm_i2c_read(dev, eeprom_addr, (uint8_t *)&record.header,
401 sizeof(record.header));
406 * Check for end of list marker. If we reached it don't go
407 * any further and stop parsing right here.
409 if (record.header.id == TI_AM6_EEPROM_RECORD_END_LIST)
412 eeprom_addr += sizeof(record.header);
414 debug("%s: dev_addr=0x%02x header.id=%u header.len=%u\n",
415 __func__, dev_addr, record.header.id,
418 /* Read record into memory if it fits */
419 if (record.header.len <= sizeof(record.data)) {
420 rc = dm_i2c_read(dev, eeprom_addr,
421 (uint8_t *)&record.data,
427 rc = ti_i2c_eeprom_am6_parse_record(&record, ep,
432 pr_err("%s: EEPROM parsing error!\n", __func__);
437 * We may get here in case of larger records which
438 * are not yet understood.
440 pr_err("%s: Ignoring record id %u\n", __func__,
444 eeprom_addr += record.header.len;
450 int __maybe_unused ti_i2c_eeprom_am6_get_base(int bus_addr, int dev_addr)
452 struct ti_am6_eeprom *ep = TI_AM6_EEPROM_DATA;
456 * Always execute EEPROM read by not allowing to bypass it during the
457 * first invocation of SPL which happens on the R5 core.
459 #if !(defined(CONFIG_SPL_BUILD) && defined(CONFIG_CPU_V7R))
460 if (ep->header == TI_EEPROM_HEADER_MAGIC) {
461 debug("%s: EEPROM has already been read\n", __func__);
466 ret = ti_i2c_eeprom_am6_get(bus_addr, dev_addr, ep,
467 (char **)ep->mac_addr,
468 AM6_EEPROM_HDR_NO_OF_MAC_ADDR,
473 bool __maybe_unused board_ti_is(char *name_tag)
475 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
477 if (ep->header == TI_DEAD_EEPROM_MAGIC)
479 return !strncmp(ep->name, name_tag, TI_EEPROM_HDR_NAME_LEN);
482 bool __maybe_unused board_ti_rev_is(char *rev_tag, int cmp_len)
484 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
487 if (ep->header == TI_DEAD_EEPROM_MAGIC)
490 l = cmp_len > TI_EEPROM_HDR_REV_LEN ? TI_EEPROM_HDR_REV_LEN : cmp_len;
491 return !strncmp(ep->version, rev_tag, l);
494 char * __maybe_unused board_ti_get_rev(void)
496 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
498 /* if ep->header == TI_DEAD_EEPROM_MAGIC, this is empty already */
502 char * __maybe_unused board_ti_get_config(void)
504 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
506 /* if ep->header == TI_DEAD_EEPROM_MAGIC, this is empty already */
510 char * __maybe_unused board_ti_get_name(void)
512 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
514 /* if ep->header == TI_DEAD_EEPROM_MAGIC, this is empty already */
519 board_ti_get_eth_mac_addr(int index,
520 u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN])
522 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
524 if (ep->header == TI_DEAD_EEPROM_MAGIC)
527 if (index < 0 || index >= TI_EEPROM_HDR_NO_OF_MAC_ADDR)
530 memcpy(mac_addr, ep->mac_addr[index], TI_EEPROM_HDR_ETH_ALEN);
534 memset(mac_addr, 0, TI_EEPROM_HDR_ETH_ALEN);
538 board_ti_am6_get_eth_mac_addr(int index,
539 u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN])
541 struct ti_am6_eeprom *ep = TI_AM6_EEPROM_DATA;
543 if (ep->header == TI_DEAD_EEPROM_MAGIC)
546 if (index < 0 || index >= ep->mac_addr_cnt)
549 memcpy(mac_addr, ep->mac_addr[index], TI_EEPROM_HDR_ETH_ALEN);
553 memset(mac_addr, 0, TI_EEPROM_HDR_ETH_ALEN);
556 u64 __maybe_unused board_ti_get_emif1_size(void)
558 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
560 if (ep->header != DRA7_EEPROM_HEADER_MAGIC)
563 return ep->emif1_size;
566 u64 __maybe_unused board_ti_get_emif2_size(void)
568 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
570 if (ep->header != DRA7_EEPROM_HEADER_MAGIC)
573 return ep->emif2_size;
576 void __maybe_unused set_board_info_env(char *name)
578 char *unknown = "unknown";
579 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
582 env_set("board_name", name);
584 env_set("board_name", ep->name);
586 env_set("board_name", unknown);
589 env_set("board_rev", ep->version);
591 env_set("board_rev", unknown);
594 env_set("board_serial", ep->serial);
596 env_set("board_serial", unknown);
599 void __maybe_unused set_board_info_env_am6(char *name)
601 char *unknown = "unknown";
602 struct ti_am6_eeprom *ep = TI_AM6_EEPROM_DATA;
605 env_set("board_name", name);
607 env_set("board_name", ep->name);
609 env_set("board_name", unknown);
612 env_set("board_rev", ep->version);
614 env_set("board_rev", unknown);
616 if (ep->software_revision)
617 env_set("board_software_revision", ep->software_revision);
619 env_set("board_software_revision", unknown);
622 env_set("board_serial", ep->serial);
624 env_set("board_serial", unknown);
627 static u64 mac_to_u64(u8 mac[6])
632 for (i = 0; i < 6; i++) {
640 static void u64_to_mac(u64 addr, u8 mac[6])
650 void board_ti_set_ethaddr(int index)
655 u8 mac_addr1[6], mac_addr2[6];
658 * Export any Ethernet MAC addresses from EEPROM.
659 * The 2 MAC addresses in EEPROM define the address range.
661 board_ti_get_eth_mac_addr(0, mac_addr1);
662 board_ti_get_eth_mac_addr(1, mac_addr2);
664 if (is_valid_ethaddr(mac_addr1) && is_valid_ethaddr(mac_addr2)) {
665 mac1 = mac_to_u64(mac_addr1);
666 mac2 = mac_to_u64(mac_addr2);
668 /* must contain an address range */
669 num_macs = mac2 - mac1 + 1;
674 printf("%s: Too many MAC addresses: %d. Limiting to 50\n",
679 for (i = 0; i < num_macs; i++) {
680 u64_to_mac(mac1 + i, mac_addr);
681 if (is_valid_ethaddr(mac_addr)) {
682 eth_env_set_enetaddr_by_index("eth", i + index,
689 void board_ti_am6_set_ethaddr(int index, int count)
694 for (i = 0; i < count; i++) {
695 board_ti_am6_get_eth_mac_addr(i, mac_addr);
696 if (is_valid_ethaddr(mac_addr))
697 eth_env_set_enetaddr_by_index("eth", i + index,
702 bool __maybe_unused board_ti_was_eeprom_read(void)
704 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
706 if (ep->header == TI_EEPROM_HEADER_MAGIC)