sram  2.0.0.0
sram.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 SRAM_H
36 #define SRAM_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_spi_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
63 #define SRAM_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
65  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
66  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
67  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
68  cfg.hld = MIKROBUS( mikrobus, MIKROBUS_RST )
69 
75 #define SRAM_RETVAL uint8_t
76 
77 #define SRAM_OK 0x00
78 #define SRAM_INIT_ERROR 0xFF
79 
85 #define SRAM_CMD_WRMR 0x01
86 #define SRAM_CMD_WRITE 0x02
87 #define SRAM_CMD_READ 0x03
88 #define SRAM_CMD_RDMR 0x05
89 #define SRAM_CMD_EQIO 0x38
90 #define SRAM_CMD_EDIO 0x3B
91 #define SRAM_CMD_RSTIO 0xFF
92 
98 #define SRAM_MODE_REG_BM 0x00
99 #define SRAM_MODE_REG_PM 0x80
100 #define SRAM_MODE_REG_SM 0x40
101  // End group macro
104 // --------------------------------------------------------------- PUBLIC TYPES
113 typedef struct
114 {
115  // Output pins
116 
117  digital_out_t hld;
118  digital_out_t cs;
119 
120  // Modules
121 
122  spi_master_t spi;
123  pin_name_t chip_select;
124 
125 } sram_t;
126 
130 typedef struct
131 {
132  // Communication gpio pins
133 
134  pin_name_t miso;
135  pin_name_t mosi;
136  pin_name_t sck;
137  pin_name_t cs;
138 
139  // Additional gpio pins
140 
141  pin_name_t hld;
142 
143  // static variable
144 
145  uint32_t spi_speed;
146  uint8_t spi_mode;
147  spi_master_chip_select_polarity_t cs_polarity;
148 
149 } sram_cfg_t;
150  // End types group
152 
153 // ------------------------------------------------------------------ CONSTANTS // End constants group
161 
162 // ------------------------------------------------------------------ VARIABLES // End variable group
170 
171 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
172 
177 #ifdef __cplusplus
178 extern "C"{
179 #endif
180 
190 
200 
213 (
214  sram_t *ctx,
215  uint8_t *wr_buf,
216  uint16_t wr_len,
217  uint8_t *rd_buf,
218  uint16_t rd_len
219 );
220 
231 (
232  sram_t *ctx,
233  uint8_t *wr_buf,
234  uint16_t wr_len
235 );
236 
246 void sram_write_byte( sram_t *ctx, uint32_t reg_address, uint8_t write_data );
247 
256 uint8_t sram_read_byte( sram_t *ctx, uint32_t reg_address );
257 
266 void sram_write_mode_reg_ins ( sram_t *ctx, uint8_t ins_data );
267 
276 
284 void sram_soft_reset ( sram_t *ctx );
285 
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 #endif // _SRAM_H_
299  // End public_function group
302 
303 // ------------------------------------------------------------------------- END
sram_cfg_t
Click configuration structure definition.
Definition: sram.h:131
sram_t::spi
spi_master_t spi
Definition: sram.h:122
sram_cfg_t::cs
pin_name_t cs
Definition: sram.h:137
sram_cfg_setup
void sram_cfg_setup(sram_cfg_t *cfg)
Config Object Initialization function.
sram_generic_transfer
void sram_generic_transfer(sram_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
SRAM_RETVAL
#define SRAM_RETVAL
Definition: sram.h:75
sram_write_byte
void sram_write_byte(sram_t *ctx, uint32_t reg_address, uint8_t write_data)
Generic write byte of data funcion.
sram_t::hld
digital_out_t hld
Definition: sram.h:117
sram_hold_transmission
void sram_hold_transmission(sram_t *ctx)
Suspend transmission funcion.
sram_t::cs
digital_out_t cs
Definition: sram.h:118
sram_read_mode_reg_ins
uint8_t sram_read_mode_reg_ins(sram_t *ctx)
Read mode register instruction funcion.
sram_generic_write
void sram_generic_write(sram_t *ctx, uint8_t *wr_buf, uint16_t wr_len)
Generic write function.
sram_cfg_t::miso
pin_name_t miso
Definition: sram.h:134
sram_t::chip_select
pin_name_t chip_select
Definition: sram.h:123
sram_cfg_t::hld
pin_name_t hld
Definition: sram.h:141
sram_cfg_t::sck
pin_name_t sck
Definition: sram.h:136
sram_read_byte
uint8_t sram_read_byte(sram_t *ctx, uint32_t reg_address)
Generic read byte of data funcion.
sram_cfg_t::spi_speed
uint32_t spi_speed
Definition: sram.h:145
sram_soft_reset
void sram_soft_reset(sram_t *ctx)
Soft reset funcion.
sram_init
SRAM_RETVAL sram_init(sram_t *ctx, sram_cfg_t *cfg)
Initialization function.
sram_t
Click ctx object definition.
Definition: sram.h:114
sram_cfg_t::spi_mode
uint8_t spi_mode
Definition: sram.h:146
sram_write_mode_reg_ins
void sram_write_mode_reg_ins(sram_t *ctx, uint8_t ins_data)
Write mode register instruction funcion.
sram_cfg_t::mosi
pin_name_t mosi
Definition: sram.h:135
sram_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: sram.h:147