include/flash/at45.h

Go to the documentation of this file.

#ifndef FLASH_AT45_H_INCLUDED
#define FLASH_AT45_H_INCLUDED

#define AT45_PS_256     (0 << 0) //!< Page size 256 bytes
#define AT45_PS_512     (1 << 0) //!< Page size 512 bytes
#define AT45_PS_1024    (2 << 0) //!< Page size 1024 bytes
#define AT45_PS_MASK    (7 << 0) //!< Page size mask bits
#define AT45_SS_128P    (0 << 3) //!< Sector size 128 pages
#define AT45_SS_256P    (1 << 3) //!< Sector size 256 bytes
#define AT45_SS_MASK    (3 << 3) //!< Sector size mask bits
#define AT45_DS_4S      (0 << 4) //!< Device size 4 sectors
#define AT45_DS_8S      (1 << 4) //!< Device size 8 sectors
#define AT45_DS_16S     (2 << 4) //!< Device size 16 sectors
#define AT45_DS_32S     (3 << 4) //!< Device size 32 sectors
#define AT45_DS_64S     (4 << 4) //!< Device size 64 sectors
#define AT45_DS_MASK    (7 << 4) //!< Device size mask bits



#define AT45DB011D      (AT45_PS_256 | AT45_SS_128P | AT45_DS_4S)

#define AT45DB021D      (AT45_PS_256 | AT45_SS_128P | AT45_DS_8S)

#define AT45DB041D      (AT45_PS_256 | AT45_SS_256P | AT45_DS_8S)

#define AT45DB081D      (AT45_PS_256 | AT45_SS_256P | AT45_DS_16S)

#define AT45DB161D      (AT45_PS_512 | AT45_SS_256P | AT45_DS_16S)

#define AT45DB321D      (AT45_PS_512 | AT45_SS_128P | AT45_DS_64S)

#define AT45DB642D      (AT45_PS_1024 | AT45_SS_256P | AT45_DS_32S)


enum at45_cmd {
        AT45_CMD_CONTINOUS_ARRAY_READ                    = 0x0b,
        AT45_CMD_MAIN_MEMORY_TO_BUFFER_1_TRANSFER        = 0x53,
        AT45_CMD_BUFFER_1_MAIN_MEMORY_PROGRAM_WITH_ERASE = 0x83,
        AT45_CMD_BUFFER_1_WRITE                          = 0x84,
        AT45_CMD_READ_ID                                 = 0x9f,
        AT45_CMD_READ_STATUS_REG                         = 0xd7,
};

enum at45_status_bit {
        AT45_STATUS_PAGE_SIZE = 0, 
        AT45_STATUS_PROTECT   = 1, 
        AT45_STATUS_COMP      = 6, 
        AT45_STATUS_RDY       = 7, 
};

#define AT45_PAGE_ADDR_MASK             ((1 << 13) - 1)

#define AT45_PAGE_POS_MASK              ((1 << 11) - 1)

#define AT45_ATMEL_JEDEC_ID             0x1f

#define AT45_DATAFLASH_FAMILY_CODE      0x20

#define AT45_FAMILY_CODE_MASK           0xe0

#define AT45_DENSITY_CODE_MIN           2

#define AT45_DENSITY_CODE_MAX           8

#define AT45_DENSITY_CODE_MASK          0x1f

#define AT45_DENSITY_CODE_0_DEVICE_SIZE 0x8000L

#define AT45_PAGE_SIZE_ID_0_SIZE        256

static const uint8_t at45_density_table[] = {
        [2] = AT45DB011D,
        [3] = AT45DB021D,
        [4] = AT45DB041D,
        [5] = AT45DB081D,
        [6] = AT45DB161D,
        [7] = AT45DB321D,
        [8] = AT45DB642D,
};

static inline bool at45_is_atmel_jedec_id(uint8_t manuf_id)
{
        return manuf_id == AT45_ATMEL_JEDEC_ID;
}

static inline bool at45_is_dataflash_family_code(uint8_t device_id1)
{
        return (device_id1 & AT45_FAMILY_CODE_MASK)
                        == AT45_DATAFLASH_FAMILY_CODE;
}

static inline uint8_t at45_get_density_code(uint8_t device_id1)
{
        return device_id1 & AT45_DENSITY_CODE_MASK;
}

static inline bool at45_is_valid_density_code(uint8_t device_id1)
{
        uint8_t density_code = at45_get_density_code(device_id1);

        return (density_code >= AT45_DENSITY_CODE_MIN)
                        && (density_code <= AT45_DENSITY_CODE_MAX);
}

static inline bool at45_is_valid_id(uint8_t manuf_id, uint8_t device_id1)
{
        return at45_is_atmel_jedec_id(manuf_id)
                        && at45_is_dataflash_family_code(device_id1)
                        && at45_is_valid_density_code(device_id1);
}

static inline uint32_t at45_get_size(uint8_t device_id1)
{
        // Every step up in density code doubles the size so just shift it
        return AT45_DENSITY_CODE_0_DEVICE_SIZE
                        << at45_get_density_code(device_id1);
}

static inline uint32_t at45_get_page_size(uint8_t device_id1)
{
        uint8_t density;

        density = at45_density_table[at45_get_density_code(device_id1)];

        /* Every step up in id for page size doubles the page size so just
         * shift it.
         */
        return AT45_PAGE_SIZE_ID_0_SIZE << (density & AT45_PS_MASK);
}


#endif /* FLASH_AT45_H_INCLUDED */

---