excelonultra.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef EXCELONULTRA_H
#define EXCELONULTRA_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
#define EXCELONULTRA_CMD_WREN       0x06/*< Write Enable*/
#define EXCELONULTRA_CMD_WRDI       0x04/*< Write Disable*/
 
#define EXCELONULTRA_CMD_WRSR       0x01/*< Write Status Register 1*/
#define EXCELONULTRA_CMD_RDSR1      0x05/*< Read Status Register 1*/
#define EXCELONULTRA_CMD_RDSR2      0x07/*< Read Status Register 2*/
#define EXCELONULTRA_CMD_RDCR1      0x32/*< Read Status Configuration Register 1*/
#define EXCELONULTRA_CMD_RDCR2      0x3F/*< Read Status Configuration Register 2*/
#define EXCELONULTRA_CMD_RDCR4      0x45/*< Read Status Configuration Register 4*/
#define EXCELONULTRA_CMD_RDCR5      0x5E/*< Read Status Configuration Register 5*/
#define EXCELONULTRA_CMD_WRAR       0x71/*< Write Any Register*/
#define EXCELONULTRA_CMD_RDAR       0x65/*< Rrite Any Register*/
 
#define EXCELONULTRA_CMD_READ       0x03/*< Memory Read*/
#define EXCELONULTRA_CMD_FAST_READ  0x0B/*< Memory Fast Read*/
#define EXCELONULTRA_CMD_WRITE      0x02/*< Memory Write*/
#define EXCELONULTRA_CMD_FAST_WRITE 0xDA/*< Memory Fast Write*/
#define EXCELONULTRA_CMD_SSWR       0x42/*< Special Sector Write*/
#define EXCELONULTRA_CMD_SSRD       0x4B/*< Special Sector Read*/
 
#define EXCELONULTRA_CMD_CLECC      0x1B/*< Clear ECC Register*/
#define EXCELONULTRA_CMD_ECCRD      0x19/*< ECC Status Read*/
#define EXCELONULTRA_CMD_CRCC       0x5B/*< CRC Calculation*/
#define EXCELONULTRA_CMD_EPCS       0x75/*< CRC Suspend*/
#define EXCELONULTRA_CMD_EPCR       0x7A/*< CRC Resume*/
 
#define EXCELONULTRA_CMD_RUID       0x4C/*< Read Unique ID*/
#define EXCELONULTRA_CMD_RDID       0x9F/*< Read Device ID*/
#define EXCELONULTRA_CMD_WRSN       0xC2/*< Write Serial Number*/
#define EXCELONULTRA_CMD_RDSN       0xC3/*< Read Serial Number*/
 
#define EXCELONULTRA_CMD_DPD        0xB9/*< Deep Power Down*/
#define EXCELONULTRA_CMD_HBN        0xBA/*< Hibernate Mode*/
#define EXCELONULTRA_CMD_RSTEN      0x66/*< Reset Enable*/
#define EXCELONULTRA_CMD_RST        0x99/*< Software Reset*/
 
 
 // excelonultra_cmd
 
#define EXCELONULTRA_MAX_MEMORY_ADDRESS 0x1FFFFF
 
 // excelonultra_set
 
#define EXCELONULTRA_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM );
#define EXCELONULTRA_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // excelonultra_map
 // excelonultra
 
typedef struct
{
    // Output pins
    digital_out_t  rst;         
    digital_out_t  wp;          
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
    //Static variables
    uint8_t unique_id[ 8 ];     
    uint16_t manufacturer_id;   
    uint16_t product_id;        
    uint8_t density_id;         
    uint8_t die_rev;            
} excelonultra_t;
typedef struct {…};
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;           
    pin_name_t  mosi;           
    pin_name_t  sck;            
    pin_name_t  cs;             
    // Additional gpio pins
    pin_name_t  rst;            
    pin_name_t  wp;             
    // Communication variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} excelonultra_cfg_t;
typedef struct {…};
 
typedef enum
{
   EXCELONULTRA_OK = 0,
   EXCELONULTRA_ERROR = -1
 
} excelonultra_return_value_t;
typedef enum {…};
 
void excelonultra_cfg_setup ( excelonultra_cfg_t *cfg );
 
err_t excelonultra_init ( excelonultra_t *ctx, excelonultra_cfg_t *cfg );
 
err_t excelonultra_default_cfg ( excelonultra_t *ctx );
 
err_t excelonultra_send_cmd ( excelonultra_t *ctx, uint8_t cmd ) ;
 
err_t excelonultra_generic_transfer 
( excelonultra_t *ctx, uint8_t *data_in, uint32_t len_in, uint8_t *data_out, uint32_t len_out ) ;
 
err_t excelonultra_generic_write ( excelonultra_t *ctx, uint8_t *data_in, uint32_t len_in );
 
err_t excelonultra_get_device_identification ( excelonultra_t *ctx );
 
err_t excelonultra_write_byte_to_memory ( excelonultra_t *ctx, uint32_t mem_adr, uint8_t mem_data );
 
err_t excelonultra_write_data_to_memory 
( excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data, uint32_t mem_data_len );
 
err_t excelonultra_read_byte_from_memory 
( excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data );
 
err_t excelonultra_read_data_from_memory 
( excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data, uint32_t mem_data_len );
 
err_t excelonultra_clear_byte_from_memory ( excelonultra_t *ctx, uint32_t mem_adr );
 
err_t excelonultra_clear_data_from_memory 
( excelonultra_t *ctx, uint32_t mem_adr, uint32_t mem_data_len );
 
void excelonultra_set_rst_pin ( excelonultra_t *ctx, uint8_t state );
 
void excelonultra_set_wp_pin ( excelonultra_t *ctx, uint8_t state );
 
void excelonultra_hw_reset ( excelonultra_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EXCELONULTRA_H
 
 // excelonultra
 
// ------------------------------------------------------------------------ END