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>
17 #include "board_detect.h"
19 #if !defined(CONFIG_DM_I2C)
21 * ti_i2c_eeprom_init - Initialize an i2c bus and probe for a device
22 * @i2c_bus: i2c bus number to initialize
23 * @dev_addr: Device address to probe for
25 * Return: 0 on success or corresponding error on failure.
27 static int __maybe_unused ti_i2c_eeprom_init(int i2c_bus, int dev_addr)
32 rc = i2c_set_bus_num(i2c_bus);
37 return i2c_probe(dev_addr);
41 * ti_i2c_eeprom_read - Read data from an EEPROM
42 * @dev_addr: The device address of the EEPROM
43 * @offset: Offset to start reading in the EEPROM
44 * @ep: Pointer to a buffer to read into
45 * @epsize: Size of buffer
47 * Return: 0 on success or corresponding result of i2c_read
49 static int __maybe_unused ti_i2c_eeprom_read(int dev_addr, int offset,
50 uchar *ep, int epsize)
52 return i2c_read(dev_addr, offset, 2, ep, epsize);
57 * ti_eeprom_string_cleanup() - Handle eeprom programming errors
58 * @s: eeprom string (should be NULL terminated)
60 * Some Board manufacturers do not add a NULL termination at the
61 * end of string, instead some binary information is kludged in, hence
62 * convert the string to just printable characters of ASCII chart.
64 static void __maybe_unused ti_eeprom_string_cleanup(char *s)
69 for (i = 0; i < l; i++, s++)
70 if (*s < ' ' || *s > '~') {
76 __weak void gpi2c_init(void)
80 static int __maybe_unused ti_i2c_eeprom_get(int bus_addr, int dev_addr,
81 u32 header, u32 size, uint8_t *ep)
86 #if defined(CONFIG_DM_I2C)
90 rc = uclass_get_device_by_seq(UCLASS_I2C, bus_addr, &bus);
93 rc = i2c_get_chip(bus, dev_addr, 1, &dev);
98 * Read the header first then only read the other contents.
100 rc = i2c_set_chip_offset_len(dev, 2);
104 rc = dm_i2c_read(dev, 0, (uint8_t *)&hdr_read, 4);
108 /* Corrupted data??? */
109 if (hdr_read != header) {
110 rc = dm_i2c_read(dev, 0, (uint8_t *)&hdr_read, 4);
112 * read the eeprom header using i2c again, but use only a
113 * 1 byte address (some legacy boards need this..)
116 rc = i2c_set_chip_offset_len(dev, 1);
120 rc = dm_i2c_read(dev, 0, (uint8_t *)&hdr_read, 4);
125 if (hdr_read != header)
128 rc = dm_i2c_read(dev, 0, ep, size);
135 rc = ti_i2c_eeprom_init(bus_addr, dev_addr);
140 * Read the header first then only read the other contents.
144 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 4);
148 /* Corrupted data??? */
149 if (hdr_read != header) {
150 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 4);
152 * read the eeprom header using i2c again, but use only a
153 * 1 byte address (some legacy boards need this..)
157 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read,
163 if (hdr_read != header)
166 rc = i2c_read(dev_addr, 0x0, byte, ep, size);
173 int __maybe_unused ti_i2c_eeprom_am_set(const char *name, const char *rev)
175 struct ti_common_eeprom *ep;
181 if (ep->header == TI_EEPROM_HEADER_MAGIC)
184 /* Set to 0 all fields */
185 memset(ep, 0, sizeof(*ep));
186 strncpy(ep->name, name, TI_EEPROM_HDR_NAME_LEN);
187 strncpy(ep->version, rev, TI_EEPROM_HDR_REV_LEN);
188 /* Some dummy serial number to identify the platform */
189 strncpy(ep->serial, "0000", TI_EEPROM_HDR_SERIAL_LEN);
190 /* Mark it with a valid header */
191 ep->header = TI_EEPROM_HEADER_MAGIC;
197 int __maybe_unused ti_i2c_eeprom_am_get(int bus_addr, int dev_addr)
200 struct ti_am_eeprom am_ep;
201 struct ti_common_eeprom *ep;
204 #ifndef CONFIG_SPL_BUILD
205 if (ep->header == TI_EEPROM_HEADER_MAGIC)
206 return 0; /* EEPROM has already been read */
209 /* Initialize with a known bad marker for i2c fails.. */
210 ep->header = TI_DEAD_EEPROM_MAGIC;
212 ep->version[0] = 0x0;
216 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, TI_EEPROM_HEADER_MAGIC,
217 sizeof(am_ep), (uint8_t *)&am_ep);
221 ep->header = am_ep.header;
222 strlcpy(ep->name, am_ep.name, TI_EEPROM_HDR_NAME_LEN + 1);
223 ti_eeprom_string_cleanup(ep->name);
225 /* BeagleBone Green '1' eeprom, board_rev: 0x1a 0x00 0x00 0x00 */
226 if (am_ep.version[0] == 0x1a && am_ep.version[1] == 0x00 &&
227 am_ep.version[2] == 0x00 && am_ep.version[3] == 0x00)
228 strlcpy(ep->version, "BBG1", TI_EEPROM_HDR_REV_LEN + 1);
230 strlcpy(ep->version, am_ep.version, TI_EEPROM_HDR_REV_LEN + 1);
231 ti_eeprom_string_cleanup(ep->version);
232 strlcpy(ep->serial, am_ep.serial, TI_EEPROM_HDR_SERIAL_LEN + 1);
233 ti_eeprom_string_cleanup(ep->serial);
234 strlcpy(ep->config, am_ep.config, TI_EEPROM_HDR_CONFIG_LEN + 1);
235 ti_eeprom_string_cleanup(ep->config);
237 memcpy(ep->mac_addr, am_ep.mac_addr,
238 TI_EEPROM_HDR_NO_OF_MAC_ADDR * TI_EEPROM_HDR_ETH_ALEN);
243 int __maybe_unused ti_i2c_eeprom_dra7_get(int bus_addr, int dev_addr)
246 struct dra7_eeprom dra7_ep;
247 struct ti_common_eeprom *ep;
250 #ifndef CONFIG_SPL_BUILD
251 if (ep->header == DRA7_EEPROM_HEADER_MAGIC)
252 return 0; /* EEPROM has already been read */
255 /* Initialize with a known bad marker for i2c fails.. */
256 ep->header = TI_DEAD_EEPROM_MAGIC;
258 ep->version[0] = 0x0;
264 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, DRA7_EEPROM_HEADER_MAGIC,
265 sizeof(dra7_ep), (uint8_t *)&dra7_ep);
269 ep->header = dra7_ep.header;
270 strlcpy(ep->name, dra7_ep.name, TI_EEPROM_HDR_NAME_LEN + 1);
271 ti_eeprom_string_cleanup(ep->name);
273 offset = dra7_ep.version_major - 1;
275 /* Rev F is skipped */
278 snprintf(ep->version, TI_EEPROM_HDR_REV_LEN + 1, "%c.%d",
279 'A' + offset, dra7_ep.version_minor);
280 ti_eeprom_string_cleanup(ep->version);
281 ep->emif1_size = (u64)dra7_ep.emif1_size;
282 ep->emif2_size = (u64)dra7_ep.emif2_size;
283 strlcpy(ep->config, dra7_ep.config, TI_EEPROM_HDR_CONFIG_LEN + 1);
284 ti_eeprom_string_cleanup(ep->config);
289 static int ti_i2c_eeprom_am6_parse_record(struct ti_am6_eeprom_record *record,
290 struct ti_am6_eeprom *ep,
295 switch (record->header.id) {
296 case TI_AM6_EEPROM_RECORD_BOARD_INFO:
297 if (record->header.len != sizeof(record->data.board_info))
303 /* Populate (and clean, if needed) the board name */
304 strlcpy(ep->name, record->data.board_info.name,
306 ti_eeprom_string_cleanup(ep->name);
308 /* Populate selected other fields from the board info record */
309 strlcpy(ep->version, record->data.board_info.version,
310 sizeof(ep->version));
311 strlcpy(ep->software_revision,
312 record->data.board_info.software_revision,
313 sizeof(ep->software_revision));
314 strlcpy(ep->serial, record->data.board_info.serial,
317 case TI_AM6_EEPROM_RECORD_MAC_INFO:
318 if (record->header.len != sizeof(record->data.mac_info))
321 if (!mac_addr || !mac_addr_max_cnt)
324 *mac_addr_cnt = ((record->data.mac_info.mac_control &
325 TI_AM6_EEPROM_MAC_ADDR_COUNT_MASK) >>
326 TI_AM6_EEPROM_MAC_ADDR_COUNT_SHIFT) + 1;
329 * The EEPROM can (but may not) hold a very large amount
330 * of MAC addresses, by far exceeding what we want/can store
331 * in the common memory array, so only grab what we can fit.
332 * Note that a value of 0 means 1 MAC address, and so on.
334 *mac_addr_cnt = min(*mac_addr_cnt, mac_addr_max_cnt);
336 memcpy(mac_addr, record->data.mac_info.mac_addr,
337 *mac_addr_cnt * TI_EEPROM_HDR_ETH_ALEN);
340 /* Illegal value... Fall through... */
342 /* Illegal value... Something went horribly wrong... */
345 pr_warn("%s: Ignoring record id %u\n", __func__,
352 int __maybe_unused ti_i2c_eeprom_am6_get(int bus_addr, int dev_addr,
353 struct ti_am6_eeprom *ep,
360 unsigned int eeprom_addr;
361 struct ti_am6_eeprom_record_board_id board_id;
362 struct ti_am6_eeprom_record record;
365 /* Initialize with a known bad marker for i2c fails.. */
366 memset(ep, 0, sizeof(*ep));
367 ep->header = TI_DEAD_EEPROM_MAGIC;
369 /* Read the board ID record which is always the first EEPROM record */
370 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, TI_EEPROM_HEADER_MAGIC,
371 sizeof(board_id), (uint8_t *)&board_id);
375 if (board_id.header.id != TI_AM6_EEPROM_RECORD_BOARD_ID) {
376 pr_err("%s: Invalid board ID record!\n", __func__);
380 /* Establish DM handle to board config EEPROM */
381 rc = uclass_get_device_by_seq(UCLASS_I2C, bus_addr, &bus);
384 rc = i2c_get_chip(bus, dev_addr, 1, &dev);
388 ep->header = TI_EEPROM_HEADER_MAGIC;
390 /* Ready to parse TLV structure. Initialize variables... */
394 * After the all-encompassing board ID record all other records follow
395 * a TLV-type scheme. Point to the first such record and then start
396 * parsing those one by one.
398 eeprom_addr = sizeof(board_id);
401 rc = dm_i2c_read(dev, eeprom_addr, (uint8_t *)&record.header,
402 sizeof(record.header));
407 * Check for end of list marker. If we reached it don't go
408 * any further and stop parsing right here.
410 if (record.header.id == TI_AM6_EEPROM_RECORD_END_LIST)
413 eeprom_addr += sizeof(record.header);
415 debug("%s: dev_addr=0x%02x header.id=%u header.len=%u\n",
416 __func__, dev_addr, record.header.id,
419 /* Read record into memory if it fits */
420 if (record.header.len <= sizeof(record.data)) {
421 rc = dm_i2c_read(dev, eeprom_addr,
422 (uint8_t *)&record.data,
428 rc = ti_i2c_eeprom_am6_parse_record(&record, ep,
433 pr_err("%s: EEPROM parsing error!\n", __func__);
438 * We may get here in case of larger records which
439 * are not yet understood.
441 pr_err("%s: Ignoring record id %u\n", __func__,
445 eeprom_addr += record.header.len;
451 int __maybe_unused ti_i2c_eeprom_am6_get_base(int bus_addr, int dev_addr)
453 struct ti_am6_eeprom *ep = TI_AM6_EEPROM_DATA;
457 * Always execute EEPROM read by not allowing to bypass it during the
458 * first invocation of SPL which happens on the R5 core.
460 #if !(defined(CONFIG_SPL_BUILD) && defined(CONFIG_CPU_V7R))
461 if (ep->header == TI_EEPROM_HEADER_MAGIC) {
462 debug("%s: EEPROM has already been read\n", __func__);
467 ret = ti_i2c_eeprom_am6_get(bus_addr, dev_addr, ep,
468 (char **)ep->mac_addr,
469 AM6_EEPROM_HDR_NO_OF_MAC_ADDR,
474 bool __maybe_unused board_ti_is(char *name_tag)
476 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
478 if (ep->header == TI_DEAD_EEPROM_MAGIC)
480 return !strncmp(ep->name, name_tag, TI_EEPROM_HDR_NAME_LEN);
483 bool __maybe_unused board_ti_rev_is(char *rev_tag, int cmp_len)
485 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
488 if (ep->header == TI_DEAD_EEPROM_MAGIC)
491 l = cmp_len > TI_EEPROM_HDR_REV_LEN ? TI_EEPROM_HDR_REV_LEN : cmp_len;
492 return !strncmp(ep->version, rev_tag, l);
495 char * __maybe_unused board_ti_get_rev(void)
497 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
499 /* if ep->header == TI_DEAD_EEPROM_MAGIC, this is empty already */
503 char * __maybe_unused board_ti_get_config(void)
505 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
507 /* if ep->header == TI_DEAD_EEPROM_MAGIC, this is empty already */
511 char * __maybe_unused board_ti_get_name(void)
513 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
515 /* if ep->header == TI_DEAD_EEPROM_MAGIC, this is empty already */
520 board_ti_get_eth_mac_addr(int index,
521 u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN])
523 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
525 if (ep->header == TI_DEAD_EEPROM_MAGIC)
528 if (index < 0 || index >= TI_EEPROM_HDR_NO_OF_MAC_ADDR)
531 memcpy(mac_addr, ep->mac_addr[index], TI_EEPROM_HDR_ETH_ALEN);
535 memset(mac_addr, 0, TI_EEPROM_HDR_ETH_ALEN);
539 board_ti_am6_get_eth_mac_addr(int index,
540 u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN])
542 struct ti_am6_eeprom *ep = TI_AM6_EEPROM_DATA;
544 if (ep->header == TI_DEAD_EEPROM_MAGIC)
547 if (index < 0 || index >= ep->mac_addr_cnt)
550 memcpy(mac_addr, ep->mac_addr[index], TI_EEPROM_HDR_ETH_ALEN);
554 memset(mac_addr, 0, TI_EEPROM_HDR_ETH_ALEN);
557 u64 __maybe_unused board_ti_get_emif1_size(void)
559 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
561 if (ep->header != DRA7_EEPROM_HEADER_MAGIC)
564 return ep->emif1_size;
567 u64 __maybe_unused board_ti_get_emif2_size(void)
569 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
571 if (ep->header != DRA7_EEPROM_HEADER_MAGIC)
574 return ep->emif2_size;
577 void __maybe_unused set_board_info_env(char *name)
579 char *unknown = "unknown";
580 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
583 env_set("board_name", name);
585 env_set("board_name", ep->name);
587 env_set("board_name", unknown);
590 env_set("board_rev", ep->version);
592 env_set("board_rev", unknown);
595 env_set("board_serial", ep->serial);
597 env_set("board_serial", unknown);
600 void __maybe_unused set_board_info_env_am6(char *name)
602 char *unknown = "unknown";
603 struct ti_am6_eeprom *ep = TI_AM6_EEPROM_DATA;
606 env_set("board_name", name);
608 env_set("board_name", ep->name);
610 env_set("board_name", unknown);
613 env_set("board_rev", ep->version);
615 env_set("board_rev", unknown);
617 if (ep->software_revision)
618 env_set("board_software_revision", ep->software_revision);
620 env_set("board_software_revision", unknown);
623 env_set("board_serial", ep->serial);
625 env_set("board_serial", unknown);
628 static u64 mac_to_u64(u8 mac[6])
633 for (i = 0; i < 6; i++) {
641 static void u64_to_mac(u64 addr, u8 mac[6])
651 void board_ti_set_ethaddr(int index)
656 u8 mac_addr1[6], mac_addr2[6];
659 * Export any Ethernet MAC addresses from EEPROM.
660 * The 2 MAC addresses in EEPROM define the address range.
662 board_ti_get_eth_mac_addr(0, mac_addr1);
663 board_ti_get_eth_mac_addr(1, mac_addr2);
665 if (is_valid_ethaddr(mac_addr1) && is_valid_ethaddr(mac_addr2)) {
666 mac1 = mac_to_u64(mac_addr1);
667 mac2 = mac_to_u64(mac_addr2);
669 /* must contain an address range */
670 num_macs = mac2 - mac1 + 1;
675 printf("%s: Too many MAC addresses: %d. Limiting to 50\n",
680 for (i = 0; i < num_macs; i++) {
681 u64_to_mac(mac1 + i, mac_addr);
682 if (is_valid_ethaddr(mac_addr)) {
683 eth_env_set_enetaddr_by_index("eth", i + index,
690 void board_ti_am6_set_ethaddr(int index, int count)
695 for (i = 0; i < count; i++) {
696 board_ti_am6_get_eth_mac_addr(i, mac_addr);
697 if (is_valid_ethaddr(mac_addr))
698 eth_env_set_enetaddr_by_index("eth", i + index,
703 bool __maybe_unused board_ti_was_eeprom_read(void)
705 struct ti_common_eeprom *ep = TI_EEPROM_DATA;
707 if (ep->header == TI_EEPROM_HEADER_MAGIC)