include/flash/at45_device.h

Go to the documentation of this file.

#ifndef FLASH_AT45_DEVICE_H_INCLUDED
#define FLASH_AT45_DEVICE_H_INCLUDED

#include <flash/at45.h>


enum at45_device_flag {
        AT45_FLAG_VALID,     
        AT45_FLAG_PROTECTED, 
};

// Forward reference
struct at45_device;

typedef bool (*at45_next_call_t)(struct at45_device *at45d);

struct at45_device {
        struct spi_master     *spim;
        struct spi_device     *spid;
        spi_id_t              spi_id;
        at45_next_call_t      next;
        uint32_t              size;
        uint16_t              page_size;
        uint8_t               flags;
        unsigned char         cmdrsp[5];
};

static inline void at45_request(struct at45_device *at45d,
                struct workqueue_task *task)
{
        spi_request_bus(at45d->spim, task);
}

static inline void at45_release(struct at45_device *at45d)
{
        spi_release_bus(at45d->spim);
}

static inline void at45_select(struct at45_device *at45d)
{
        spi_select_device(at45d->spi_id, at45d->spim, at45d->spid);
}

static inline void at45_deselect(struct at45_device *at45d)
{
        spi_deselect_device(at45d->spi_id, at45d->spim, at45d->spid);
}

static inline void at45_write_cmd(struct at45_device *at45d, uint8_t size)
{
        assert(size <= sizeof(at45d->cmdrsp));

        spi_write(at45d->spi_id, at45d->spim, at45d->cmdrsp, size);
}

static inline void at45_read_rsp(struct at45_device *at45d, uint8_t size)
{
        assert(size <= sizeof(at45d->cmdrsp));

        spi_read(at45d->spi_id, at45d->spim, at45d->cmdrsp, size);
}

static inline void at45_cmd_read_status_reg(struct at45_device *at45d)
{
        at45d->cmdrsp[0] = AT45_CMD_READ_STATUS_REG;
        at45_write_cmd(at45d, 1);
}

static inline void at45_cmd_read_id(struct at45_device *at45d)
{
        at45d->cmdrsp[0] = AT45_CMD_READ_ID;
        at45_write_cmd(at45d, 1);
}

static inline void at45_cmd_cont_array_read(struct at45_device *at45d, uint16_t page,
                uint16_t pos)
{
        assert(!(page & ~AT45_PAGE_ADDR_MASK));
        assert(!(pos & ~AT45_PAGE_POS_MASK));

        at45d->cmdrsp[0] = AT45_CMD_CONTINOUS_ARRAY_READ;
        /* 24-bit address split between 13-bits page and 11-bits position in
         * page.
         */
        at45d->cmdrsp[1] = page >> 5;
        at45d->cmdrsp[2] = (page << 3) | (pos >> 8);
        at45d->cmdrsp[3] = pos;
        at45d->cmdrsp[4] = 0; // Dummy byte required for this command
        at45_write_cmd(at45d, 5);
}

static inline void at45_cmd_buffer_1_write(struct at45_device *at45d, uint16_t pos)
{
        assert(!(pos & ~AT45_PAGE_POS_MASK));

        at45d->cmdrsp[0] = AT45_CMD_BUFFER_1_WRITE;
        /* 24-bit address split between 13-bits don't care and 11-bits position
         * in page.
         */
        at45d->cmdrsp[2] = pos >> 8;
        at45d->cmdrsp[3] = pos;
        at45_write_cmd(at45d, 4);
}

static inline void at45_cmd_main_memory_to_buffer_1_transfer(struct at45_device *at45d,
                uint16_t page)
{
        assert(!(page & ~AT45_PAGE_ADDR_MASK));

        at45d->cmdrsp[0] = AT45_CMD_MAIN_MEMORY_TO_BUFFER_1_TRANSFER;
        // 24-bit address split between 13-bits page and 11-bits don't care
        at45d->cmdrsp[1] = page >> 5;
        at45d->cmdrsp[2] = page << 3;
        at45_write_cmd(at45d, 4);
}

static inline void at45_cmd_buffer_1_main_memory_program_with_erase(
                struct at45_device *at45d, uint16_t page)
{
        assert(!(page & ~AT45_PAGE_ADDR_MASK));

        at45d->cmdrsp[0] = AT45_CMD_BUFFER_1_MAIN_MEMORY_PROGRAM_WITH_ERASE;
        // 24-bit address split between 13-bits page and 11-bits don't care
        at45d->cmdrsp[1] = page >> 5;
        at45d->cmdrsp[2] = page << 3;
        at45_write_cmd(at45d, 4);
}

static inline void at45_read_buf_list(struct at45_device *at45d,
                struct slist *buf_list)
{
        spi_read_buf_list(at45d->spi_id, at45d->spim, buf_list);
}

static inline void at45_write_buf_list(struct at45_device *at45d,
                struct slist *buf_list)
{
        spi_write_buf_list(at45d->spi_id, at45d->spim, buf_list);
}

static inline bool at45_rsp_status_is_ready(struct at45_device *at45d)
{
        return at45d->cmdrsp[0] & (1 << AT45_STATUS_RDY);
}

static inline bool at45_rsp_status_is_protected(struct at45_device *at45d)
{
        return at45d->cmdrsp[0] & (1 << AT45_STATUS_PROTECT);
}

bool at45_wait_ready(struct at45_device *at45d);
bool at45_identify(struct at45_device *at45d);
void at45_device_init(struct at45_device *at45d, spi_id_t spi_id,
                struct spi_master *spim, struct spi_device *spid);

#endif /* FLASH_AT45_DEVICE_H_INCLUDED */

---