fram6.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 FRAM6_H
#define FRAM6_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"
#include "spi_specifics.h"
 
#define FRAM6_OPCODE_WREN                   0x06
#define FRAM6_OPCODE_WRDI                   0x04
#define FRAM6_OPCODE_RDSR                   0x05
#define FRAM6_OPCODE_WRSR                   0x01
#define FRAM6_OPCODE_READ                   0x03
#define FRAM6_OPCODE_FSTRD                  0x0B
#define FRAM6_OPCODE_WRITE                  0x02
#define FRAM6_OPCODE_SLEEP                  0xB9
#define FRAM6_OPCODE_RDID                   0x9F
 
 // fram6_reg
 
#define FRAM6_WEL_BIT_MASK                  0x02
#define FRAM6_BLOCK_PROTECT_BITS_MASK       0x0C
#define FRAM6_BLOCK_PROTECT_NONE            0x00
#define FRAM6_BLOCK_PROTECT_UPPER_QUARTER   0x04
#define FRAM6_BLOCK_PROTECT_UPPER_HALF      0x08
#define FRAM6_BLOCK_PROTECT_ALL             0x0C
#define FRAM6_WPEN_BIT_MASK                 0x80
 
#define FRAM6_MIN_ADDRESS                   0x00000
#define FRAM6_MAX_ADDRESS                   0x3FFFF
 
#define FRAM6_SET_DATA_SAMPLE_EDGE          SET_SPI_DATA_SAMPLE_EDGE
#define FRAM6_SET_DATA_SAMPLE_MIDDLE        SET_SPI_DATA_SAMPLE_MIDDLE
 
 // fram6_set
 
#define FRAM6_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.wp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.hld = MIKROBUS( mikrobus, MIKROBUS_PWM );
#define FRAM6_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // fram6_map
 // fram6
 
typedef struct
{
    // Output pins
    digital_out_t  wp;          
    digital_out_t  hld;         
    // Modules
    spi_master_t   spi;         
    pin_name_t     chip_select; 
} fram6_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  wp;                                     
    pin_name_t  hld;                                    
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} fram6_cfg_t;
typedef struct {…};
 
typedef enum
{
    FRAM6_OK = 0,
    FRAM6_ERROR = -1
 
} fram6_return_value_t;
typedef enum {…};
 
void fram6_cfg_setup ( fram6_cfg_t *cfg );
 
err_t fram6_init ( fram6_t *ctx, fram6_cfg_t *cfg );
 
err_t fram6_default_cfg ( fram6_t *ctx );
 
err_t fram6_write_opcode ( fram6_t *ctx, uint8_t opcode );
 
err_t fram6_read_opcode ( fram6_t *ctx, uint8_t opcode, uint8_t *data_out, uint8_t len );
 
err_t fram6_check_communication ( fram6_t *ctx );
 
void fram6_set_wp_pin ( fram6_t *ctx, uint8_t state );
 
void fram6_set_hld_pin ( fram6_t *ctx, uint8_t state );
 
err_t fram6_enable_write ( fram6_t *ctx );
 
err_t fram6_disable_write ( fram6_t *ctx );
 
err_t fram6_set_block_protection ( fram6_t *ctx, uint8_t block_protect );
 
err_t fram6_write_status ( fram6_t *ctx, uint8_t status );
 
err_t fram6_read_status ( fram6_t *ctx, uint8_t *status );
 
err_t fram6_enter_sleep_mode ( fram6_t *ctx );
 
void fram6_wakeup_from_sleep ( fram6_t *ctx );
 
err_t fram6_memory_write ( fram6_t *ctx, uint32_t address, uint8_t *data_in, uint16_t len );
 
err_t fram6_memory_read ( fram6_t *ctx, uint32_t address, uint8_t *data_out, uint16_t len );
 
err_t fram6_memory_read_fast ( fram6_t *ctx, uint32_t address, uint8_t *data_out, uint16_t len );
 
#ifdef __cplusplus
}
#endif
#endif // FRAM6_H
 
 // fram6
 
// ------------------------------------------------------------------------ END