drivers/misc/ds4510.c

   1 /*
   2  * Copyright 2008 Extreme Engineering Solutions, Inc.
   3  *
   4  * SPDX-License-Identifier:     GPL-2.0
   5  */
   6
   7 /*
   8  * Driver for DS4510, a CPU supervisor with integrated EEPROM, SRAM,
   9  * and 4 programmable non-volatile GPIO pins.
  10  */
  11
  12 #include <common.h>
  13 #include <i2c.h>
  14 #include <command.h>
  15 #include "ds4510.h"
  16
  17 /* Default to an address that hopefully won't corrupt other i2c devices */
  18 #ifndef CONFIG_SYS_I2C_DS4510_ADDR
  19 #define CONFIG_SYS_I2C_DS4510_ADDR      (~0)
  20 #endif
  21
  22 enum {
  23         DS4510_CMD_INFO,
  24         DS4510_CMD_DEVICE,
  25         DS4510_CMD_NV,
  26         DS4510_CMD_RSTDELAY,
  27         DS4510_CMD_OUTPUT,
  28         DS4510_CMD_INPUT,
  29         DS4510_CMD_PULLUP,
  30         DS4510_CMD_EEPROM,
  31         DS4510_CMD_SEEPROM,
  32         DS4510_CMD_SRAM,
  33 };
  34
  35 /*
  36  * Write to DS4510, taking page boundaries into account
  37  */
  38 static int ds4510_mem_write(uint8_t chip, int offset, uint8_t *buf, int count)
  39 {
  40         int wrlen;
  41         int i = 0;
  42
  43         do {
  44                 wrlen = DS4510_EEPROM_PAGE_SIZE -
  45                         DS4510_EEPROM_PAGE_OFFSET(offset);
  46                 if (count < wrlen)
  47                         wrlen = count;
  48                 if (i2c_write(chip, offset, 1, &buf[i], wrlen))
  49                         return -1;
  50
  51                 /*
  52                  * This delay isn't needed for SRAM writes but shouldn't delay
  53                  * things too much, so do it unconditionally for simplicity
  54                  */
  55                 udelay(DS4510_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
  56                 count -= wrlen;
  57                 offset += wrlen;
  58                 i += wrlen;
  59         } while (count > 0);
  60
  61         return 0;
  62 }
  63
  64 /*
  65  * General read from DS4510
  66  */
  67 static int ds4510_mem_read(uint8_t chip, int offset, uint8_t *buf, int count)
  68 {
  69         return i2c_read(chip, offset, 1, buf, count);
  70 }
  71
  72 /*
  73  * Write SEE bit in config register.
  74  * nv = 0 - Writes to SEEPROM registers behave like EEPROM
  75  * nv = 1 - Writes to SEEPROM registers behave like SRAM
  76  */
  77 static int ds4510_see_write(uint8_t chip, uint8_t nv)
  78 {
  79         uint8_t data;
  80
  81         if (i2c_read(chip, DS4510_CFG, 1, &data, 1))
  82                 return -1;
  83
  84         if (nv) /* Treat SEEPROM bits as EEPROM */
  85                 data &= ~DS4510_CFG_SEE;
  86         else    /* Treat SEEPROM bits as SRAM */
  87                 data |= DS4510_CFG_SEE;
  88
  89         return ds4510_mem_write(chip, DS4510_CFG, &data, 1);
  90 }
  91
  92 /*
  93  * Write de-assertion of reset signal delay
  94  */
  95 static int ds4510_rstdelay_write(uint8_t chip, uint8_t delay)
  96 {
  97         uint8_t data;
  98
  99         if (i2c_read(chip, DS4510_RSTDELAY, 1, &data, 1))
 100                 return -1;
 101
 102         data &= ~DS4510_RSTDELAY_MASK;
 103         data |= delay & DS4510_RSTDELAY_MASK;
 104
 105         return ds4510_mem_write(chip, DS4510_RSTDELAY, &data, 1);
 106 }
 107
 108 /*
 109  * Write pullup characteristics of IO pins
 110  */
 111 static int ds4510_pullup_write(uint8_t chip, uint8_t val)
 112 {
 113         val &= DS4510_IO_MASK;
 114
 115         return ds4510_mem_write(chip, DS4510_PULLUP, (uint8_t *)&val, 1);
 116 }
 117
 118 /*
 119  * Read pullup characteristics of IO pins
 120  */
 121 static int ds4510_pullup_read(uint8_t chip)
 122 {
 123         uint8_t val;
 124
 125         if (i2c_read(chip, DS4510_PULLUP, 1, &val, 1))
 126                 return -1;
 127
 128         return val & DS4510_IO_MASK;
 129 }
 130
 131 /*
 132  * Write drive level of IO pins
 133  */
 134 static int ds4510_gpio_write(uint8_t chip, uint8_t val)
 135 {
 136         uint8_t data;
 137         int i;
 138
 139         for (i = 0; i < DS4510_NUM_IO; i++) {
 140                 if (i2c_read(chip, DS4510_IO0 - i, 1, &data, 1))
 141                         return -1;
 142
 143                 if (val & (0x1 << i))
 144                         data |= 0x1;
 145                 else
 146                         data &= ~0x1;
 147
 148                 if (ds4510_mem_write(chip, DS4510_IO0 - i, &data, 1))
 149                         return -1;
 150         }
 151
 152         return 0;
 153 }
 154
 155 /*
 156  * Read drive level of IO pins
 157  */
 158 static int ds4510_gpio_read(uint8_t chip)
 159 {
 160         uint8_t data;
 161         int val = 0;
 162         int i;
 163
 164         for (i = 0; i < DS4510_NUM_IO; i++) {
 165                 if (i2c_read(chip, DS4510_IO0 - i, 1, &data, 1))
 166                         return -1;
 167
 168                 if (data & 1)
 169                         val |= (1 << i);
 170         }
 171
 172         return val;
 173 }
 174
 175 /*
 176  * Read physical level of IO pins
 177  */
 178 static int ds4510_gpio_read_val(uint8_t chip)
 179 {
 180         uint8_t val;
 181
 182         if (i2c_read(chip, DS4510_IO_STATUS, 1, &val, 1))
 183                 return -1;
 184
 185         return val & DS4510_IO_MASK;
 186 }
 187
 188 /*
 189  * Display DS4510 information
 190  */
 191 static int ds4510_info(uint8_t chip)
 192 {
 193         int i;
 194         int tmp;
 195         uint8_t data;
 196
 197         printf("DS4510 @ 0x%x:\n\n", chip);
 198
 199         if (i2c_read(chip, DS4510_RSTDELAY, 1, &data, 1))
 200                 return -1;
 201         printf("rstdelay = 0x%x\n\n", data & DS4510_RSTDELAY_MASK);
 202
 203         if (i2c_read(chip, DS4510_CFG, 1, &data, 1))
 204                 return -1;
 205         printf("config   = 0x%x\n", data);
 206         printf(" /ready  = %d\n", data & DS4510_CFG_READY ? 1 : 0);
 207         printf(" trip pt = %d\n", data & DS4510_CFG_TRIP_POINT ? 1 : 0);
 208         printf(" rst sts = %d\n", data & DS4510_CFG_RESET ? 1 : 0);
 209         printf(" /see    = %d\n", data & DS4510_CFG_SEE ? 1 : 0);
 210         printf(" swrst   = %d\n\n", data & DS4510_CFG_SWRST ? 1 : 0);
 211
 212         printf("gpio pins: 3210\n");
 213         printf("---------------\n");
 214         printf("pullup     ");
 215
 216         tmp = ds4510_pullup_read(chip);
 217         if (tmp == -1)
 218                 return tmp;
 219         for (i = DS4510_NUM_IO - 1; i >= 0; i--)
 220                 printf("%d", (tmp & (1 << i)) ? 1 : 0);
 221         printf("\n");
 222
 223         printf("driven     ");
 224         tmp = ds4510_gpio_read(chip);
 225         if (tmp == -1)
 226                 return -1;
 227         for (i = DS4510_NUM_IO - 1; i >= 0; i--)
 228                 printf("%d", (tmp & (1 << i)) ? 1 : 0);
 229         printf("\n");
 230
 231         printf("read       ");
 232         tmp = ds4510_gpio_read_val(chip);
 233         if (tmp == -1)
 234                 return -1;
 235         for (i = DS4510_NUM_IO - 1; i >= 0; i--)
 236                 printf("%d", (tmp & (1 << i)) ? 1 : 0);
 237         printf("\n");
 238
 239         return 0;
 240 }
 241
 242 cmd_tbl_t cmd_ds4510[] = {
 243         U_BOOT_CMD_MKENT(device, 3, 0, (void *)DS4510_CMD_DEVICE, "", ""),
 244         U_BOOT_CMD_MKENT(nv, 3, 0, (void *)DS4510_CMD_NV, "", ""),
 245         U_BOOT_CMD_MKENT(output, 4, 0, (void *)DS4510_CMD_OUTPUT, "", ""),
 246         U_BOOT_CMD_MKENT(input, 3, 0, (void *)DS4510_CMD_INPUT, "", ""),
 247         U_BOOT_CMD_MKENT(pullup, 4, 0, (void *)DS4510_CMD_PULLUP, "", ""),
 248         U_BOOT_CMD_MKENT(info, 2, 0, (void *)DS4510_CMD_INFO, "", ""),
 249         U_BOOT_CMD_MKENT(rstdelay, 3, 0, (void *)DS4510_CMD_RSTDELAY, "", ""),
 250         U_BOOT_CMD_MKENT(eeprom, 6, 0, (void *)DS4510_CMD_EEPROM, "", ""),
 251         U_BOOT_CMD_MKENT(seeprom, 6, 0, (void *)DS4510_CMD_SEEPROM, "", ""),
 252         U_BOOT_CMD_MKENT(sram, 6, 0, (void *)DS4510_CMD_SRAM, "", ""),
 253 };
 254
 255 int do_ds4510(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 256 {
 257         static uint8_t chip = CONFIG_SYS_I2C_DS4510_ADDR;
 258         cmd_tbl_t *c;
 259         ulong ul_arg2 = 0;
 260         ulong ul_arg3 = 0;
 261         int tmp;
 262         ulong addr;
 263         ulong off;
 264         ulong cnt;
 265         int end;
 266         int (*rw_func)(uint8_t, int, uint8_t *, int);
 267
 268         c = find_cmd_tbl(argv[1], cmd_ds4510, ARRAY_SIZE(cmd_ds4510));
 269
 270         /* All commands but "device" require 'maxargs' arguments */
 271         if (!c || !((argc == (c->maxargs)) ||
 272                 (((int)c->cmd == DS4510_CMD_DEVICE) &&
 273                  (argc == (c->maxargs - 1))))) {
 274                 return cmd_usage(cmdtp);
 275         }
 276
 277         /* arg2 used as chip addr and pin number */
 278         if (argc > 2)
 279                 ul_arg2 = simple_strtoul(argv[2], NULL, 16);
 280
 281         /* arg3 used as output/pullup value */
 282         if (argc > 3)
 283                 ul_arg3 = simple_strtoul(argv[3], NULL, 16);
 284
 285         switch ((int)c->cmd) {
 286         case DS4510_CMD_DEVICE:
 287                 if (argc == 3)
 288                         chip = ul_arg2;
 289                 printf("Current device address: 0x%x\n", chip);
 290                 return 0;
 291         case DS4510_CMD_NV:
 292                 return ds4510_see_write(chip, ul_arg2);
 293         case DS4510_CMD_OUTPUT:
 294                 tmp = ds4510_gpio_read(chip);
 295                 if (tmp == -1)
 296                         return -1;
 297                 if (ul_arg3)
 298                         tmp |= (1 << ul_arg2);
 299                 else
 300                         tmp &= ~(1 << ul_arg2);
 301                 return ds4510_gpio_write(chip, tmp);
 302         case DS4510_CMD_INPUT:
 303                 tmp = ds4510_gpio_read_val(chip);
 304                 if (tmp == -1)
 305                         return -1;
 306                 return (tmp & (1 << ul_arg2)) != 0;
 307         case DS4510_CMD_PULLUP:
 308                 tmp = ds4510_pullup_read(chip);
 309                 if (tmp == -1)
 310                         return -1;
 311                 if (ul_arg3)
 312                         tmp |= (1 << ul_arg2);
 313                 else
 314                         tmp &= ~(1 << ul_arg2);
 315                 return ds4510_pullup_write(chip, tmp);
 316         case DS4510_CMD_INFO:
 317                 return ds4510_info(chip);
 318         case DS4510_CMD_RSTDELAY:
 319                 return ds4510_rstdelay_write(chip, ul_arg2);
 320         case DS4510_CMD_EEPROM:
 321                 end = DS4510_EEPROM + DS4510_EEPROM_SIZE;
 322                 off = DS4510_EEPROM;
 323                 break;
 324         case DS4510_CMD_SEEPROM:
 325                 end = DS4510_SEEPROM + DS4510_SEEPROM_SIZE;
 326                 off = DS4510_SEEPROM;
 327                 break;
 328         case DS4510_CMD_SRAM:
 329                 end = DS4510_SRAM + DS4510_SRAM_SIZE;
 330                 off = DS4510_SRAM;
 331                 break;
 332         default:
 333                 /* We should never get here... */
 334                 return 1;
 335         }
 336
 337         /* Only eeprom, seeprom, and sram commands should make it here */
 338         if (strcmp(argv[2], "read") == 0)
 339                 rw_func = ds4510_mem_read;
 340         else if (strcmp(argv[2], "write") == 0)
 341                 rw_func = ds4510_mem_write;
 342         else
 343                 return cmd_usage(cmdtp);
 344
 345         addr = simple_strtoul(argv[3], NULL, 16);
 346         off += simple_strtoul(argv[4], NULL, 16);
 347         cnt = simple_strtoul(argv[5], NULL, 16);
 348
 349         if ((off + cnt) > end) {
 350                 printf("ERROR: invalid len\n");
 351                 return -1;
 352         }
 353
 354         return rw_func(chip, off, (uint8_t *)addr, cnt);
 355 }
 356
 357 U_BOOT_CMD(
 358         ds4510, 6,      1,      do_ds4510,
 359         "ds4510 eeprom/seeprom/sram/gpio access",
 360         "device [dev]\n"
 361         "       - show or set current device address\n"
 362         "ds4510 info\n"
 363         "       - display ds4510 info\n"
 364         "ds4510 output pin 0|1\n"
 365         "       - set pin low or high-Z\n"
 366         "ds4510 input pin\n"
 367         "       - read value of pin\n"
 368         "ds4510 pullup pin 0|1\n"
 369         "       - disable/enable pullup on specified pin\n"
 370         "ds4510 nv 0|1\n"
 371         "       - make gpio and seeprom writes volatile/non-volatile"
 372         "\n"
 373         "ds4510 rstdelay 0-3\n"
 374         "       - set reset output delay"
 375         "\n"
 376         "ds4510 eeprom read addr off cnt\n"
 377         "ds4510 eeprom write addr off cnt\n"
 378         "       - read/write 'cnt' bytes at EEPROM offset 'off'\n"
 379         "ds4510 seeprom read addr off cnt\n"
 380         "ds4510 seeprom write addr off cnt\n"
 381         "       - read/write 'cnt' bytes at SRAM-shadowed EEPROM offset 'off'\n"
 382         "ds4510 sram read addr off cnt\n"
 383         "ds4510 sram write addr off cnt\n"
 384         "       - read/write 'cnt' bytes at SRAM offset 'off'"
 385 );