mtd_spi_nor.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Eistec AB
 * SPDX-FileCopyrightText: 2017 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "periph_conf.h"
#include "periph/spi.h"
#include "periph/gpio.h"
#include "mtd.h"
 
#ifdef __cplusplus
extern "C"
{
#endif

typedef struct {
    uint8_t rdid;            
    uint8_t wren;            
    uint8_t rdsr;            
    uint8_t wrsr;            
    uint8_t read;            
    uint8_t read_fast;       
    uint8_t page_program;    
    uint8_t sector_erase;    
    uint8_t block_erase_32k; 
    uint8_t block_erase_64k; 
    uint8_t chip_erase;      
    uint8_t sleep;           
    uint8_t wake;            
    /* TODO: enter 4 byte address mode for large memories */
} mtd_spi_nor_opcode_t;

typedef struct __attribute__((packed)) {
    uint8_t bank;      
    uint8_t manuf;     
    uint8_t device[2]; 
} mtd_jedec_id_t;

#define JEDEC_NEXT_BANK (0x7f)

#define JEDEC_BANK_MAX  (10)

#define SPI_NOR_F_SECT_4K   (1)

#define SPI_NOR_F_SECT_32K  (2)

#define SPI_NOR_F_SECT_64K  (4)

typedef struct {
    const mtd_spi_nor_opcode_t *opcode; 
    uint32_t wait_chip_erase;   
    uint32_t wait_64k_erase;    
    uint32_t wait_32k_erase;    
    uint32_t wait_sector_erase; 
    uint32_t wait_chip_wake_up; 
    spi_clk_t clk;           
    uint16_t flag;           
    spi_t spi;               
    spi_mode_t mode;         
    gpio_t cs;               
    gpio_t wp;               
    gpio_t hold;             
} mtd_spi_nor_params_t;

typedef struct {
    mtd_dev_t base;          
    const mtd_spi_nor_params_t *params; 
    mtd_jedec_id_t jedec_id; 

    uint32_t page_addr_mask;
    uint32_t sec_addr_mask;
    uint8_t page_addr_shift;
    uint8_t sec_addr_shift;
    uint8_t addr_width;
} mtd_spi_nor_t;

extern const mtd_desc_t mtd_spi_nor_driver;
 
/* Available opcode tables for known devices */
/* Defined in mtd_spi_nor_configs.c */
extern const mtd_spi_nor_opcode_t mtd_spi_nor_opcode_default;

extern const mtd_spi_nor_opcode_t mtd_spi_nor_opcode_default_4bytes;
 
#ifdef __cplusplus
}
#endif