sram.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 SRAM_H
#define SRAM_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 SRAM_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.hld   = MIKROBUS( mikrobus, MIKROBUS_RST )
#define SRAM_RETVAL  uint8_t
 
#define SRAM_OK                       0x00
#define SRAM_INIT_ERROR               0xFF
#define SRAM_CMD_WRMR                 0x01
#define SRAM_CMD_WRITE                0x02
#define SRAM_CMD_READ                 0x03
#define SRAM_CMD_RDMR                 0x05
#define SRAM_CMD_EQIO                 0x38
#define SRAM_CMD_EDIO                 0x3B
#define SRAM_CMD_RSTIO                0xFF
#define SRAM_MODE_REG_BM              0x00
#define SRAM_MODE_REG_PM              0x80
#define SRAM_MODE_REG_SM              0x40
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t hld;
    digital_out_t cs;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} sram_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 hld;
 
    // static variable 
 
    uint32_t spi_speed;
    uint8_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} sram_cfg_t;
 
 // End types group
 
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
 
// ------------------------------------------------------------------ VARIABLES
 // End variable group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void sram_cfg_setup ( sram_cfg_t *cfg );
 
SRAM_RETVAL sram_init ( sram_t *ctx, sram_cfg_t *cfg );
 
void sram_generic_transfer 
( 
    sram_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
void sram_generic_write 
( 
    sram_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len
);
 
void sram_write_byte( sram_t *ctx, uint32_t reg_address, uint8_t write_data );
 
uint8_t sram_read_byte( sram_t *ctx, uint32_t reg_address );
 
void sram_write_mode_reg_ins ( sram_t *ctx, uint8_t ins_data );
 
uint8_t sram_read_mode_reg_ins ( sram_t *ctx );
 
void sram_soft_reset ( sram_t *ctx );
 
void sram_hold_transmission ( sram_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _SRAM_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END