git.gag.com Git - fw/altos/blob - src/drivers/ao_m25.c

   1 /*
   2  * Copyright © 2010 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17  */
  18
  19 #include "ao.h"
  20
  21 /* Total bytes of available storage */
  22 uint32_t        ao_storage_total;
  23
  24 /* Block size - device is erased in these units. At least 256 bytes */
  25 uint32_t        ao_storage_block;
  26
  27 /* Byte offset of config block. Will be ao_storage_block bytes long */
  28 uint32_t        ao_storage_config;
  29
  30 /* Storage unit size - device reads and writes must be within blocks of this size. Usually 256 bytes. */
  31 uint16_t        ao_storage_unit;
  32
  33 #define M25_DEBUG       0
  34 /*
  35  * Each flash chip is arranged in 64kB sectors; the
  36  * chip cannot erase in units smaller than that.
  37  *
  38  * Writing happens in units of 256 byte pages and
  39  * can only change bits from 1 to 0. So, you can rewrite
  40  * the same contents, or append to an existing page easily enough
  41  */
  42
  43 #define M25_WREN        0x06    /* Write Enable */
  44 #define M25_WRDI        0x04    /* Write Disable */
  45 #define M25_RDID        0x9f    /* Read Identification */
  46 #define M25_RDSR        0x05    /* Read Status Register */
  47 #define M25_WRSR        0x01    /* Write Status Register */
  48 #define M25_READ        0x03    /* Read Data Bytes */
  49 #define M25_FAST_READ   0x0b    /* Read Data Bytes at Higher Speed */
  50 #define M25_PP          0x02    /* Page Program */
  51 #define M25_SE          0xd8    /* Sector Erase */
  52 #define M25_BE          0xc7    /* Bulk Erase */
  53 #define M25_DP          0xb9    /* Deep Power-down */
  54
  55 /* RDID response */
  56 #define M25_MANUF_OFFSET        0
  57 #define M25_MEMORY_TYPE_OFFSET  1
  58 #define M25_CAPACITY_OFFSET     2
  59 #define M25_UID_OFFSET          3
  60 #define M25_CFI_OFFSET          4
  61 #define M25_RDID_LEN            4       /* that's all we need */
  62
  63 #define M25_CAPACITY_128KB      0x11
  64 #define M25_CAPACITY_256KB      0x12
  65 #define M25_CAPACITY_512KB      0x13
  66 #define M25_CAPACITY_1MB        0x14
  67 #define M25_CAPACITY_2MB        0x15
  68
  69 /*
  70  * Status register bits
  71  */
  72
  73 #define M25_STATUS_SRWD         (1 << 7)        /* Status register write disable */
  74 #define M25_STATUS_BP_MASK      (7 << 2)        /* Block protect bits */
  75 #define M25_STATUS_BP_SHIFT     (2)
  76 #define M25_STATUS_WEL          (1 << 1)        /* Write enable latch */
  77 #define M25_STATUS_WIP          (1 << 0)        /* Write in progress */
  78
  79 /*
  80  * On teleterra, the m25 chip select pins are
  81  * wired on P0_0 through P0_3.
  82  */
  83
  84 #if M25_MAX_CHIPS > 1
  85 static uint32_t ao_m25_size[M25_MAX_CHIPS];     /* number of sectors in each chip */
  86 static ao_port_t ao_m25_pin[M25_MAX_CHIPS];     /* chip select pin for each chip */
  87 static uint8_t ao_m25_numchips;                 /* number of chips detected */
  88 #endif
  89 static uint32_t ao_m25_total;                   /* total sectors available */
  90 static ao_port_t ao_m25_wip;                    /* write in progress */
  91
  92 static uint8_t ao_m25_mutex;
  93
  94 /*
  95  * This little array is abused to send and receive data. A particular
  96  * caution -- the read and write addresses are written into the last
  97  * three bytes of the array by ao_m25_set_page_address and then the
  98  * first byte is used by ao_m25_wait_wip and ao_m25_write_enable, neither
  99  * of which touch those last three bytes.
 100  */
 101
 102 static uint8_t  ao_m25_instruction[4];
 103
 104 #define M25_SELECT(cs)          ao_spi_get_mask(AO_M25_SPI_CS_PORT,cs,AO_M25_SPI_BUS, AO_SPI_SPEED_FAST)
 105 #define M25_DESELECT(cs)        ao_spi_put_mask(AO_M25_SPI_CS_PORT,cs,AO_M25_SPI_BUS)
 106
 107 #define M25_BLOCK_SHIFT                 16
 108 #define M25_BLOCK                       65536L
 109 #define M25_POS_TO_SECTOR(pos)          ((uint32_t) ((pos) >> M25_BLOCK_SHIFT))
 110 #define M25_SECTOR_TO_POS(sector)       (((uint32_t) (sector)) << M25_BLOCK_SHIFT)
 111
 112 /*
 113  * Block until the specified chip is done writing
 114  */
 115 static void
 116 ao_m25_wait_wip(ao_port_t cs)
 117 {
 118         if (ao_m25_wip & cs) {
 119                 M25_SELECT(cs);
 120                 ao_m25_instruction[0] = M25_RDSR;
 121                 ao_spi_send(ao_m25_instruction, 1, AO_M25_SPI_BUS);
 122                 do {
 123                         ao_spi_recv(ao_m25_instruction, 1, AO_M25_SPI_BUS);
 124                 } while (ao_m25_instruction[0] & M25_STATUS_WIP);
 125                 M25_DESELECT(cs);
 126                 ao_m25_wip &= ~cs;
 127         }
 128 }
 129
 130 /*
 131  * Set the write enable latch so that page program and sector
 132  * erase commands will work. Also mark the chip as busy writing
 133  * so that future operations will block until the WIP bit goes off
 134  */
 135 static void
 136 ao_m25_write_enable(ao_port_t cs)
 137 {
 138         M25_SELECT(cs);
 139         ao_m25_instruction[0] = M25_WREN;
 140         ao_spi_send(&ao_m25_instruction, 1, AO_M25_SPI_BUS);
 141         M25_DESELECT(cs);
 142         ao_m25_wip |= cs;
 143 }
 144
 145
 146 /*
 147  * Returns the number of 64kB sectors
 148  */
 149 static uint32_t
 150 ao_m25_read_capacity(ao_port_t cs)
 151 {
 152         uint8_t capacity;
 153         M25_SELECT(cs);
 154         ao_m25_instruction[0] = M25_RDID;
 155         ao_spi_send(ao_m25_instruction, 1, AO_M25_SPI_BUS);
 156         ao_spi_recv(ao_m25_instruction, M25_RDID_LEN, AO_M25_SPI_BUS);
 157         M25_DESELECT(cs);
 158
 159         /* Check to see if the chip is present */
 160         if (ao_m25_instruction[0] == 0xff)
 161                 return 0;
 162         capacity = ao_m25_instruction[M25_CAPACITY_OFFSET];
 163
 164         /* Sanity check capacity number */
 165         if (capacity < 0x11 || 0x1f < capacity)
 166                 return 0;
 167         return 1 << (capacity - 0x10);
 168 }
 169
 170 static ao_port_t
 171 ao_m25_set_address(uint32_t pos)
 172 {
 173         ao_port_t       mask;
 174 #if M25_MAX_CHIPS > 1
 175         uint32_t        size;
 176         uint8_t         chip;
 177
 178         for (chip = 0; chip < ao_m25_numchips; chip++) {
 179                 size = ao_m25_size[chip];
 180                 if (M25_POS_TO_SECTOR(pos) < size)
 181                         break;
 182                 pos -= M25_SECTOR_TO_POS(size);
 183         }
 184         if (chip == ao_m25_numchips)
 185                 return 0xff;
 186
 187         mask = ao_m25_pin[chip];
 188 #else
 189         mask = AO_M25_SPI_CS_MASK;
 190 #endif
 191         ao_m25_wait_wip(mask);
 192
 193         ao_m25_instruction[1] = pos >> 16;
 194         ao_m25_instruction[2] = pos >> 8;
 195         ao_m25_instruction[3] = pos;
 196         return mask;
 197 }
 198
 199 /*
 200  * Scan the possible chip select lines
 201  * to see which flash chips are connected
 202  */
 203 static uint8_t
 204 ao_m25_scan(void)
 205 {
 206 #if M25_MAX_CHIPS > 1
 207         uint8_t pin;
 208         uint32_t size;
 209 #endif
 210
 211         if (ao_m25_total)
 212                 return 1;
 213
 214 #if M25_MAX_CHIPS > 1
 215         ao_m25_numchips = 0;
 216         for (pin = 1; pin != 0; pin <<= 1) {
 217                 if (AO_M25_SPI_CS_MASK & pin) {
 218                         size = ao_m25_read_capacity(pin);
 219                         if (size != 0) {
 220                                 ao_m25_size[ao_m25_numchips] = size;
 221                                 ao_m25_pin[ao_m25_numchips] = pin;
 222                                 ao_m25_total += size;
 223                                 ao_m25_numchips++;
 224                         }
 225                 }
 226         }
 227 #else
 228         ao_m25_total = ao_m25_read_capacity(AO_M25_SPI_CS_MASK);
 229 #endif
 230         if (!ao_m25_total)
 231                 return 0;
 232         ao_storage_total = M25_SECTOR_TO_POS(ao_m25_total);
 233         ao_storage_block = M25_BLOCK;
 234         ao_storage_config = ao_storage_total - M25_BLOCK;
 235         ao_storage_unit = 256;
 236         return 1;
 237 }
 238
 239 /*
 240  * Erase the specified sector
 241  */
 242 uint8_t
 243 ao_storage_device_erase(uint32_t pos)
 244 {
 245         ao_port_t       cs;
 246
 247         if (pos >= ao_storage_total || pos + ao_storage_block > ao_storage_total)
 248                 return 0;
 249
 250         ao_mutex_get(&ao_m25_mutex);
 251         ao_m25_scan();
 252
 253         cs = ao_m25_set_address(pos);
 254
 255         ao_m25_write_enable(cs);
 256
 257         ao_m25_instruction[0] = M25_SE;
 258         M25_SELECT(cs);
 259         ao_spi_send(ao_m25_instruction, 4, AO_M25_SPI_BUS);
 260         M25_DESELECT(cs);
 261         ao_m25_wip |= cs;
 262
 263         ao_mutex_put(&ao_m25_mutex);
 264         return 1;
 265 }
 266
 267 /*
 268  * Write to flash
 269  */
 270 uint8_t
 271 ao_storage_device_write(uint32_t pos, void *d, uint16_t len)
 272 {
 273         ao_port_t       cs;
 274
 275         if (pos >= ao_storage_total || pos + len > ao_storage_total)
 276                 return 0;
 277
 278         ao_mutex_get(&ao_m25_mutex);
 279         ao_m25_scan();
 280
 281         cs = ao_m25_set_address(pos);
 282         ao_m25_write_enable(cs);
 283
 284         ao_m25_instruction[0] = M25_PP;
 285         M25_SELECT(cs);
 286         ao_spi_send(ao_m25_instruction, 4, AO_M25_SPI_BUS);
 287         ao_spi_send(d, len, AO_M25_SPI_BUS);
 288         M25_DESELECT(cs);
 289
 290         ao_mutex_put(&ao_m25_mutex);
 291         return 1;
 292 }
 293
 294 /*
 295  * Read from flash
 296  */
 297 uint8_t
 298 ao_storage_device_read(uint32_t pos, void *d, uint16_t len)
 299 {
 300         ao_port_t       cs;
 301
 302         if (pos >= ao_storage_total || pos + len > ao_storage_total)
 303                 return 0;
 304         ao_mutex_get(&ao_m25_mutex);
 305         ao_m25_scan();
 306
 307         cs = ao_m25_set_address(pos);
 308
 309         /* No need to use the FAST_READ as we're running at only 8MHz */
 310         ao_m25_instruction[0] = M25_READ;
 311         M25_SELECT(cs);
 312         ao_spi_send(ao_m25_instruction, 4, AO_M25_SPI_BUS);
 313         ao_spi_recv(d, len, AO_M25_SPI_BUS);
 314         M25_DESELECT(cs);
 315
 316         ao_mutex_put(&ao_m25_mutex);
 317         return 1;
 318 }
 319
 320 void
 321 ao_storage_flush(void)
 322 {
 323 }
 324
 325 void
 326 ao_storage_setup(void)
 327 {
 328         ao_mutex_get(&ao_m25_mutex);
 329         ao_m25_scan();
 330         ao_mutex_put(&ao_m25_mutex);
 331 }
 332
 333 void
 334 ao_storage_device_info(void)
 335 {
 336 #if M25_DEBUG
 337         ao_port_t       cs;
 338 #endif
 339 #if M25_MAX_CHIPS > 1
 340         uint8_t chip;
 341 #endif
 342
 343         ao_mutex_get(&ao_m25_mutex);
 344         ao_m25_scan();
 345         ao_mutex_put(&ao_m25_mutex);
 346
 347 #if M25_MAX_CHIPS > 1
 348         printf ("Detected chips %d size %ld\n", ao_m25_numchips, ao_m25_total);
 349         for (chip = 0; chip < ao_m25_numchips; chip++)
 350                 printf ("Flash chip %d select %02x size %d\n",
 351                         chip, ao_m25_pin[chip], ao_m25_size[chip]);
 352 #else
 353         printf ("Detected chips 1 size %ld\n", ao_m25_total);
 354 #endif
 355
 356 #if M25_DEBUG
 357         printf ("Available chips:\n");
 358         for (cs = 1; cs != 0; cs <<= 1) {
 359                 if ((AO_M25_SPI_CS_MASK & cs) == 0)
 360                         continue;
 361
 362                 ao_mutex_get(&ao_m25_mutex);
 363                 M25_SELECT(cs);
 364                 ao_m25_instruction[0] = M25_RDID;
 365                 ao_spi_send(ao_m25_instruction, 1, AO_M25_SPI_BUS);
 366                 ao_spi_recv(ao_m25_instruction, M25_RDID_LEN, AO_M25_SPI_BUS);
 367                 M25_DESELECT(cs);
 368
 369                 printf ("Select %02x manf %02x type %02x cap %02x uid %02x\n",
 370                         cs,
 371                         ao_m25_instruction[M25_MANUF_OFFSET],
 372                         ao_m25_instruction[M25_MEMORY_TYPE_OFFSET],
 373                         ao_m25_instruction[M25_CAPACITY_OFFSET],
 374                         ao_m25_instruction[M25_UID_OFFSET]);
 375                 ao_mutex_put(&ao_m25_mutex);
 376         }
 377 #endif
 378 }
 379
 380 void
 381 ao_storage_device_init(void)
 382 {
 383         ao_spi_init_cs (AO_M25_SPI_CS_PORT, AO_M25_SPI_CS_MASK);
 384 }