mram2.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 MRAM2_H
#define MRAM2_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_digital_in.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define MRAM2_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
#define MRAM2_OK                 0
#define MRAM2_ERROR             -1
#define MRAM2_CMD_RDSR           0x05
#define MRAM2_CMD_WREN           0x06
#define MRAM2_CMD_WRDI           0x04
#define MRAM2_CMD_WRSR           0x01
#define MRAM2_CMD_READ           0x03
#define MRAM2_CMD_FREAD          0x0B
#define MRAM2_CMD_WRITE          0x02
#define MRAM2_CMD_SLEEP          0xB9
#define MRAM2_CMD_WAKE           0xAB
#define MRAM2_CMD_TDET           0x17
#define MRAM2_CMD_TDETX          0x07
#define MRAM2_CMD_RDID           0x4B
#define MRAM2_STAT_REG_SRWD      0x80
#define MRAM2_STAT_REG_QPI       0x40
#define MRAM2_STAT_REG_BP1       0x08
#define MRAM2_STAT_REG_BP0       0x04
#define MRAM2_STAT_REG_WEL       0x02
#define MRAM2_XIP_SET_CONT       0xEF
#define MRAM2_XIP_RST_STOP       0xFF
#define MRAM2_WP_ENABLE          0x01
#define MRAM2_WP_DISABLE         0x00
#define MRAM2_HLD_ENABLE         0x01
#define MRAM2_HLD_DISABLE        0x00
#define MRAM2_PIN_LOW            0x00
#define MRAM2_PIN_HIGH           0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_out_t cs;
    // Output pins 
 
    digital_out_t rst;
    digital_out_t int_pin;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} mram2_t;
 
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 int_pin;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} mram2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void mram2_cfg_setup ( mram2_cfg_t *cfg );
 
err_t mram2_init ( mram2_t *ctx, mram2_cfg_t *cfg );
 
uint8_t mram2_rdsr ( mram2_t *ctx );
 
void mram2_wren ( mram2_t *ctx );
 
void mram2_wrdi ( mram2_t *ctx );
 
void mram2_wrsr ( mram2_t *ctx, uint8_t stat_reg );
 
void mram2_read ( mram2_t *ctx, uint32_t mem_adr, uint8_t *rd_data, uint8_t n_bytes );
 
void mram2_fread ( mram2_t *ctx, uint32_t mem_adr, uint8_t mode, uint8_t *rd_data, uint8_t n_bytes );
 
void mram2_write ( mram2_t *ctx, uint32_t mem_adr, uint8_t *wr_data, uint8_t n_bytes );
 
void mram2_sleep ( mram2_t *ctx );
 
void mram2_wake ( mram2_t *ctx );
 
uint32_t mram2_tdet ( mram2_t *ctx );
 
void mram2_tdetx ( mram2_t *ctx );
 
void mram2_rdid ( mram2_t *ctx, uint8_t *rd_id );
 
void mram2_write_protect ( mram2_t *ctx, uint8_t state );
 
void mram2_hold ( mram2_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif  // _MRAM2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END