fram  2.0.0.0
fram.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef FRAM_H
36 #define FRAM_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define FRAM_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_RST ); \
60  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM )
61 
67 #define FRAM_RETVAL uint8_t
68 
69 #define FRAM_OK 0x00
70 #define FRAM_INIT_ERROR 0xFF
71 
77 #define FRAM_WREN 0x06
78 #define FRAM_WRDI 0x04
79 #define FRAM_RDSR 0x05
80 #define FRAM_WRSR 0x01
81 #define FRAM_READ 0x03
82 #define FRAM_WRITE 0x02
83 
89 #define FRAM_WPEN 0x80
90 #define FRAM_BP1 0x08
91 #define FRAM_BP0 0x04
92 #define FRAM_WEL 0x02
93 
94 #define FRAM_MEM_SIZE 0x8000
95  // End group macro
98 // --------------------------------------------------------------- PUBLIC TYPES
107 typedef struct
108 {
109  // Output pins
110 
111  digital_out_t cs;
112  digital_out_t hld;
113  digital_out_t wp;
114 
115  // Modules
116 
117  spi_master_t spi;
118  pin_name_t chip_select;
119 
120 } fram_t;
121 
125 typedef struct
126 {
127  // Communication gpio pins
128 
129  pin_name_t miso;
130  pin_name_t mosi;
131  pin_name_t sck;
132  pin_name_t cs;
133 
134  // Additional gpio pins
135 
136  pin_name_t hld;
137  pin_name_t wp;
138 
139  // static variable
140 
141  uint32_t spi_speed;
142  spi_master_mode_t spi_mode;
143  spi_master_chip_select_polarity_t cs_polarity;
144 
145 } fram_cfg_t;
146  // End types group
148 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
149 
154 #ifdef __cplusplus
155 extern "C"{
156 #endif
157 
167 
177 
189 void fram_generic_transfer ( fram_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
190 
198 void fram_init_f ( fram_t *ctx );
199 
207 void fram_write_enable ( fram_t *ctx );
208 
217 
225 uint8_t fram_read_status ( fram_t *ctx ) ;
226 
234 void fram_write_status ( fram_t *ctx, uint8_t value );
235 
246 void fram_read ( fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count );
247 
258 void fram_write ( fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count );
259 
267 void fram_erase_all ( fram_t *ctx );
268 
269 #ifdef __cplusplus
270 }
271 #endif
272 #endif // _FRAM_H_
273  // End public_function group
276 
277 // ------------------------------------------------------------------------- END
fram_cfg_setup
void fram_cfg_setup(fram_cfg_t *cfg)
Config Object Initialization function.
fram_cfg_t::wp
pin_name_t wp
Definition: fram.h:137
fram_t::wp
digital_out_t wp
Definition: fram.h:113
fram_t::chip_select
pin_name_t chip_select
Definition: fram.h:118
fram_read_status
uint8_t fram_read_status(fram_t *ctx)
Fram click Read Status function.
fram_cfg_t::hld
pin_name_t hld
Definition: fram.h:136
FRAM_RETVAL
#define FRAM_RETVAL
Definition: fram.h:67
fram_erase_all
void fram_erase_all(fram_t *ctx)
Fram erase all function.
fram_write_status
void fram_write_status(fram_t *ctx, uint8_t value)
Fram click Write Status function.
fram_write_enable
void fram_write_enable(fram_t *ctx)
Fram click Write Enable function.
fram_t
Click ctx object definition.
Definition: fram.h:108
fram_cfg_t::mosi
pin_name_t mosi
Definition: fram.h:130
fram_cfg_t::cs
pin_name_t cs
Definition: fram.h:132
fram_generic_transfer
void fram_generic_transfer(fram_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
fram_init_f
void fram_init_f(fram_t *ctx)
Fram click init function.
fram_write_disable
void fram_write_disable(fram_t *ctx)
Fram click Write Disable function.
fram_cfg_t
Click configuration structure definition.
Definition: fram.h:126
fram_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: fram.h:143
fram_cfg_t::spi_speed
uint32_t spi_speed
Definition: fram.h:141
fram_t::spi
spi_master_t spi
Definition: fram.h:117
fram_read
void fram_read(fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count)
Fram read function.
fram_cfg_t::miso
pin_name_t miso
Definition: fram.h:129
fram_t::hld
digital_out_t hld
Definition: fram.h:112
fram_t::cs
digital_out_t cs
Definition: fram.h:111
fram_cfg_t::sck
pin_name_t sck
Definition: fram.h:131
fram_init
FRAM_RETVAL fram_init(fram_t *ctx, fram_cfg_t *cfg)
Initialization function.
fram_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: fram.h:142
fram_write
void fram_write(fram_t *ctx, uint16_t address, uint8_t *buffer, uint16_t count)
Fram write function.