reram.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 _RERAM_H_
#define _RERAM_H_
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_spi_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS
#define RERAM_ID_DATA                0x047FC903
 
#define RERAM_CMD_WREN               0x6
#define RERAM_CMD_WRDI               0x4
#define RERAM_CMD_SLEEP              0xB9
#define RERAM_BLOCK_PROT_NONE        0x0
#define RERAM_BLOCK_PROT_UPPER_1_4   0x4
#define RERAM_BLOCK_PROT_UPPER_1_2   0x8
#define RERAM_BLOCK_PROT_ALL         0xC
#define RERAM_BLOCK_PROT_MASK        0xC
#define RERAM_WP_STAT_EN             0x80
#define RERAM_WP_STAT_DIS            0x0
#define RERAM_WP_STAT_MASK           0x80
 //  End write_protect_set group
 
#define RERAM_FLAG_MASK_WEL          0x2
#define RERAM_FLAG_MASK_WIP          0x1
#define RERAM_MEM_ADDR_START         0x0
#define RERAM_MEM_ADDR_END           0x7FFFF
#define RERAM_TRANSFER_BYTES_MIN     1
#define RERAM_TRANSFER_BYTES_MAX     256
#define RERAM_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.ho  = MIKROBUS( mikrobus, MIKROBUS_RST  ); \
    cfg.cs  = MIKROBUS( mikrobus, MIKROBUS_CS   ); \
    cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK  ); \
    cfg.sdo = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.sdi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.wp  = MIKROBUS( mikrobus, MIKROBUS_PWM  )
 //  End macros group
// --------------------------------------------------------------- PUBLIC TYPES
//typedef spi_master_data_t  uint8_t;
 
typedef enum
{
    RERAM_OK = 0,
    RERAM_ERR_DRV_INIT = 0xFC,
    RERAM_ERR_CMD,
    RERAM_ERR_MEM_ADDR,
    RERAM_ERR_NBYTES
 
} reram_err_t;
 
typedef enum
{
    RERAM_PIN_STATE_LOW = 0,
    RERAM_PIN_STATE_HIGH
 
} reram_pin_state_t;
 
typedef struct
{
    digital_out_t cs;
    
    //  Control pins.
    digital_out_t  wp;
    digital_out_t  ho;
 
    //  Module.
    spi_master_t  spi;
    pin_name_t chip_select;
 
} reram_t;
 
typedef struct
{
    //  Used mikrobus pins.
    pin_name_t  ho;
    pin_name_t  cs;
    pin_name_t  sck;
    pin_name_t  sdo;
    pin_name_t  sdi;
    pin_name_t  wp;
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;  
 
} reram_cfg_t;
 
 //  End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
#ifdef __cplusplus
extern "C"{
#endif
 
void
reram_cfg_setup( reram_cfg_t *cfg );
 
reram_err_t
reram_init( reram_t *ctx, reram_cfg_t *cfg );
 
void
reram_default_cfg( reram_t *ctx );
 
reram_err_t
reram_send_cmd( reram_t *ctx, uint8_t cmd_code );
 
uint8_t
reram_read_status( reram_t *ctx );
 
void
reram_write_status( reram_t *ctx, uint8_t data_in );
 
reram_err_t
reram_read_memory( reram_t *ctx, uint32_t mem_addr,
                   uint8_t *data_out, uint16_t n_bytes );
 
reram_err_t
reram_write_memory( reram_t *ctx, uint32_t mem_addr,
                    uint8_t *data_in, uint16_t n_bytes );
 
uint32_t
reram_read_id( reram_t *ctx );
 
void
reram_set_hold_pin( reram_t *ctx, reram_pin_state_t state );
 
void
reram_set_write_protect_pin( reram_t *ctx, reram_pin_state_t state );
 
void
reram_wake_up( reram_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  //  _RERAM_H_
 
 //  End public_function group
 
// ------------------------------------------------------------------------ END