1 /* 2 * Library to support early TI EVM EEPROM handling 3 * 4 * Copyright (C) 2015-2016 Texas Instruments Incorporated - http://www.ti.com/ 5 * Lokesh Vutla 6 * Steve Kipisz 7 * 8 * SPDX-License-Identifier: GPL-2.0+ 9 */ 10 11 #include <common.h> 12 #include <asm/omap_common.h> 13 #include <i2c.h> 14 15 #include "board_detect.h" 16 17 /** 18 * ti_i2c_eeprom_init - Initialize an i2c bus and probe for a device 19 * @i2c_bus: i2c bus number to initialize 20 * @dev_addr: Device address to probe for 21 * 22 * Return: 0 on success or corresponding error on failure. 23 */ 24 static int __maybe_unused ti_i2c_eeprom_init(int i2c_bus, int dev_addr) 25 { 26 int rc; 27 28 if (i2c_bus >= 0) { 29 rc = i2c_set_bus_num(i2c_bus); 30 if (rc) 31 return rc; 32 } 33 34 return i2c_probe(dev_addr); 35 } 36 37 /** 38 * ti_i2c_eeprom_read - Read data from an EEPROM 39 * @dev_addr: The device address of the EEPROM 40 * @offset: Offset to start reading in the EEPROM 41 * @ep: Pointer to a buffer to read into 42 * @epsize: Size of buffer 43 * 44 * Return: 0 on success or corresponding result of i2c_read 45 */ 46 static int __maybe_unused ti_i2c_eeprom_read(int dev_addr, int offset, 47 uchar *ep, int epsize) 48 { 49 return i2c_read(dev_addr, offset, 2, ep, epsize); 50 } 51 52 /** 53 * ti_eeprom_string_cleanup() - Handle eeprom programming errors 54 * @s: eeprom string (should be NULL terminated) 55 * 56 * Some Board manufacturers do not add a NULL termination at the 57 * end of string, instead some binary information is kludged in, hence 58 * convert the string to just printable characters of ASCII chart. 59 */ 60 static void __maybe_unused ti_eeprom_string_cleanup(char *s) 61 { 62 int i, l; 63 64 l = strlen(s); 65 for (i = 0; i < l; i++, s++) 66 if (*s < ' ' || *s > '~') { 67 *s = 0; 68 break; 69 } 70 } 71 72 __weak void gpi2c_init(void) 73 { 74 } 75 76 static int __maybe_unused ti_i2c_eeprom_get(int bus_addr, int dev_addr, 77 u32 header, u32 size, uint8_t *ep) 78 { 79 u32 byte, hdr_read; 80 int rc; 81 82 gpi2c_init(); 83 rc = ti_i2c_eeprom_init(bus_addr, dev_addr); 84 if (rc) 85 return rc; 86 87 /* 88 * Read the header first then only read the other contents. 89 */ 90 byte = 2; 91 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 4); 92 if (rc) 93 return rc; 94 95 /* Corrupted data??? */ 96 if (hdr_read != header) { 97 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 4); 98 /* 99 * read the eeprom header using i2c again, but use only a 100 * 1 byte address (some legacy boards need this..) 101 */ 102 byte = 1; 103 if (rc) 104 rc = i2c_read(dev_addr, 0x0, byte, (uint8_t *)&hdr_read, 105 4); 106 if (rc) 107 return rc; 108 } 109 if (hdr_read != header) 110 return -1; 111 112 rc = i2c_read(dev_addr, 0x0, byte, ep, size); 113 if (rc) 114 return rc; 115 116 return 0; 117 } 118 119 int __maybe_unused ti_i2c_eeprom_am_get(int bus_addr, int dev_addr) 120 { 121 int rc; 122 struct ti_am_eeprom am_ep; 123 struct ti_common_eeprom *ep; 124 125 ep = TI_EEPROM_DATA; 126 if (ep->header == TI_EEPROM_HEADER_MAGIC) 127 goto already_read; 128 129 /* Initialize with a known bad marker for i2c fails.. */ 130 ep->header = TI_DEAD_EEPROM_MAGIC; 131 ep->name[0] = 0x0; 132 ep->version[0] = 0x0; 133 ep->serial[0] = 0x0; 134 135 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, TI_EEPROM_HEADER_MAGIC, 136 sizeof(am_ep), (uint8_t *)&am_ep); 137 if (rc) 138 return rc; 139 140 ep->header = am_ep.header; 141 strlcpy(ep->name, am_ep.name, TI_EEPROM_HDR_NAME_LEN + 1); 142 ti_eeprom_string_cleanup(ep->name); 143 144 /* BeagleBone Green '1' eeprom, board_rev: 0x1a 0x00 0x00 0x00 */ 145 if (am_ep.version[0] == 0x1a && am_ep.version[1] == 0x00 && 146 am_ep.version[2] == 0x00 && am_ep.version[3] == 0x00) 147 strlcpy(ep->version, "BBG1", TI_EEPROM_HDR_REV_LEN + 1); 148 else 149 strlcpy(ep->version, am_ep.version, TI_EEPROM_HDR_REV_LEN + 1); 150 ti_eeprom_string_cleanup(ep->version); 151 strlcpy(ep->serial, am_ep.serial, TI_EEPROM_HDR_SERIAL_LEN + 1); 152 ti_eeprom_string_cleanup(ep->serial); 153 strlcpy(ep->config, am_ep.config, TI_EEPROM_HDR_CONFIG_LEN + 1); 154 ti_eeprom_string_cleanup(ep->config); 155 156 memcpy(ep->mac_addr, am_ep.mac_addr, 157 TI_EEPROM_HDR_NO_OF_MAC_ADDR * TI_EEPROM_HDR_ETH_ALEN); 158 159 already_read: 160 return 0; 161 } 162 163 int __maybe_unused ti_i2c_eeprom_dra7_get(int bus_addr, int dev_addr) 164 { 165 int rc, offset = 0; 166 struct dra7_eeprom dra7_ep; 167 struct ti_common_eeprom *ep; 168 169 ep = TI_EEPROM_DATA; 170 if (ep->header == DRA7_EEPROM_HEADER_MAGIC) 171 goto already_read; 172 173 /* Initialize with a known bad marker for i2c fails.. */ 174 ep->header = 0xADEAD12C; 175 ep->name[0] = 0x0; 176 ep->version[0] = 0x0; 177 ep->serial[0] = 0x0; 178 ep->emif1_size = 0; 179 ep->emif2_size = 0; 180 181 rc = ti_i2c_eeprom_get(bus_addr, dev_addr, DRA7_EEPROM_HEADER_MAGIC, 182 sizeof(dra7_ep), (uint8_t *)&dra7_ep); 183 if (rc) 184 return rc; 185 186 ep->header = dra7_ep.header; 187 strlcpy(ep->name, dra7_ep.name, TI_EEPROM_HDR_NAME_LEN + 1); 188 ti_eeprom_string_cleanup(ep->name); 189 190 offset = dra7_ep.version_major - 1; 191 192 /* Rev F is skipped */ 193 if (offset >= 5) 194 offset = offset + 1; 195 snprintf(ep->version, TI_EEPROM_HDR_REV_LEN + 1, "%c.%d", 196 'A' + offset, dra7_ep.version_minor); 197 ti_eeprom_string_cleanup(ep->version); 198 ep->emif1_size = (u64)dra7_ep.emif1_size; 199 ep->emif2_size = (u64)dra7_ep.emif2_size; 200 strlcpy(ep->config, dra7_ep.config, TI_EEPROM_HDR_CONFIG_LEN + 1); 201 ti_eeprom_string_cleanup(ep->config); 202 203 already_read: 204 return 0; 205 } 206 207 bool __maybe_unused board_ti_is(char *name_tag) 208 { 209 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 210 211 if (ep->header == TI_DEAD_EEPROM_MAGIC) 212 return false; 213 return !strncmp(ep->name, name_tag, TI_EEPROM_HDR_NAME_LEN); 214 } 215 216 bool __maybe_unused board_ti_rev_is(char *rev_tag, int cmp_len) 217 { 218 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 219 int l; 220 221 if (ep->header == TI_DEAD_EEPROM_MAGIC) 222 return false; 223 224 l = cmp_len > TI_EEPROM_HDR_REV_LEN ? TI_EEPROM_HDR_REV_LEN : cmp_len; 225 return !strncmp(ep->version, rev_tag, l); 226 } 227 228 char * __maybe_unused board_ti_get_rev(void) 229 { 230 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 231 232 if (ep->header == TI_DEAD_EEPROM_MAGIC) 233 return NULL; 234 235 return ep->version; 236 } 237 238 char * __maybe_unused board_ti_get_config(void) 239 { 240 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 241 242 if (ep->header == TI_DEAD_EEPROM_MAGIC) 243 return NULL; 244 245 return ep->config; 246 } 247 248 char * __maybe_unused board_ti_get_name(void) 249 { 250 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 251 252 if (ep->header == TI_DEAD_EEPROM_MAGIC) 253 return NULL; 254 255 return ep->name; 256 } 257 258 void __maybe_unused 259 board_ti_get_eth_mac_addr(int index, 260 u8 mac_addr[TI_EEPROM_HDR_ETH_ALEN]) 261 { 262 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 263 264 if (ep->header == TI_DEAD_EEPROM_MAGIC) 265 goto fail; 266 267 if (index < 0 || index >= TI_EEPROM_HDR_NO_OF_MAC_ADDR) 268 goto fail; 269 270 memcpy(mac_addr, ep->mac_addr[index], TI_EEPROM_HDR_ETH_ALEN); 271 return; 272 273 fail: 274 memset(mac_addr, 0, TI_EEPROM_HDR_ETH_ALEN); 275 } 276 277 u64 __maybe_unused board_ti_get_emif1_size(void) 278 { 279 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 280 281 if (ep->header != DRA7_EEPROM_HEADER_MAGIC) 282 return 0; 283 284 return ep->emif1_size; 285 } 286 287 u64 __maybe_unused board_ti_get_emif2_size(void) 288 { 289 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 290 291 if (ep->header != DRA7_EEPROM_HEADER_MAGIC) 292 return 0; 293 294 return ep->emif2_size; 295 } 296 297 void __maybe_unused set_board_info_env(char *name) 298 { 299 char *unknown = "unknown"; 300 struct ti_common_eeprom *ep = TI_EEPROM_DATA; 301 302 if (name) 303 setenv("board_name", name); 304 else if (ep->name) 305 setenv("board_name", ep->name); 306 else 307 setenv("board_name", unknown); 308 309 if (ep->version) 310 setenv("board_rev", ep->version); 311 else 312 setenv("board_rev", unknown); 313 314 if (ep->serial) 315 setenv("board_serial", ep->serial); 316 else 317 setenv("board_serial", unknown); 318 } 319