excelonultra  2.0.0.0
excelonultra.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef EXCELONULTRA_H
29 #define EXCELONULTRA_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 
59 #define EXCELONULTRA_CMD_WREN 0x06/*< Write Enable*/
60 #define EXCELONULTRA_CMD_WRDI 0x04/*< Write Disable*/
61 
66 #define EXCELONULTRA_CMD_WRSR 0x01/*< Write Status Register 1*/
67 #define EXCELONULTRA_CMD_RDSR1 0x05/*< Read Status Register 1*/
68 #define EXCELONULTRA_CMD_RDSR2 0x07/*< Read Status Register 2*/
69 #define EXCELONULTRA_CMD_RDCR1 0x32/*< Read Status Configuration Register 1*/
70 #define EXCELONULTRA_CMD_RDCR2 0x3F/*< Read Status Configuration Register 2*/
71 #define EXCELONULTRA_CMD_RDCR4 0x45/*< Read Status Configuration Register 4*/
72 #define EXCELONULTRA_CMD_RDCR5 0x5E/*< Read Status Configuration Register 5*/
73 #define EXCELONULTRA_CMD_WRAR 0x71/*< Write Any Register*/
74 #define EXCELONULTRA_CMD_RDAR 0x65/*< Rrite Any Register*/
75 
80 #define EXCELONULTRA_CMD_READ 0x03/*< Memory Read*/
81 #define EXCELONULTRA_CMD_FAST_READ 0x0B/*< Memory Fast Read*/
82 #define EXCELONULTRA_CMD_WRITE 0x02/*< Memory Write*/
83 #define EXCELONULTRA_CMD_FAST_WRITE 0xDA/*< Memory Fast Write*/
84 #define EXCELONULTRA_CMD_SSWR 0x42/*< Special Sector Write*/
85 #define EXCELONULTRA_CMD_SSRD 0x4B/*< Special Sector Read*/
86 
92 #define EXCELONULTRA_CMD_CLECC 0x1B/*< Clear ECC Register*/
93 #define EXCELONULTRA_CMD_ECCRD 0x19/*< ECC Status Read*/
94 #define EXCELONULTRA_CMD_CRCC 0x5B/*< CRC Calculation*/
95 #define EXCELONULTRA_CMD_EPCS 0x75/*< CRC Suspend*/
96 #define EXCELONULTRA_CMD_EPCR 0x7A/*< CRC Resume*/
97 
102 #define EXCELONULTRA_CMD_RUID 0x4C/*< Read Unique ID*/
103 #define EXCELONULTRA_CMD_RDID 0x9F/*< Read Device ID*/
104 #define EXCELONULTRA_CMD_WRSN 0xC2/*< Write Serial Number*/
105 #define EXCELONULTRA_CMD_RDSN 0xC3/*< Read Serial Number*/
106 
111 #define EXCELONULTRA_CMD_DPD 0xB9/*< Deep Power Down*/
112 #define EXCELONULTRA_CMD_HBN 0xBA/*< Hibernate Mode*/
113 #define EXCELONULTRA_CMD_RSTEN 0x66/*< Reset Enable*/
114 #define EXCELONULTRA_CMD_RST 0x99/*< Software Reset*/
115 
116  // excelonultra_cmd
118 
133 #define EXCELONULTRA_MAX_MEMORY_ADDRESS 0x1FFFFF
134  // excelonultra_set
136 
151 #define EXCELONULTRA_MAP_MIKROBUS( cfg, mikrobus ) \
152  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
153  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
154  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
155  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
156  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
157  cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM );
158  // excelonultra_map // excelonultra
161 
166 typedef struct
167 {
168  // Output pins
169  digital_out_t rst;
170  digital_out_t wp;
172  // Modules
173  spi_master_t spi;
175  pin_name_t chip_select;
177  //Static variables
178  uint8_t unique_id[ 8 ];
179  uint16_t manufacturer_id;
180  uint16_t product_id;
181  uint8_t density_id;
182  uint8_t die_rev;
185 
190 typedef struct
191 {
192  // Communication gpio pins
193  pin_name_t miso;
194  pin_name_t mosi;
195  pin_name_t sck;
196  pin_name_t cs;
198  // Additional gpio pins
199  pin_name_t rst;
200  pin_name_t wp;
202  // Communication variable
203  uint32_t spi_speed;
204  spi_master_mode_t spi_mode;
205  spi_master_chip_select_polarity_t cs_polarity;
208 
213 typedef enum
214 {
216  EXCELONULTRA_ERROR = -1
217 
219 
236 
252 
267 
279 err_t excelonultra_send_cmd ( excelonultra_t *ctx, uint8_t cmd ) ;
280 
297 ( excelonultra_t *ctx, uint8_t *data_in, uint32_t len_in, uint8_t *data_out, uint32_t len_out ) ;
298 
312 err_t excelonultra_generic_write ( excelonultra_t *ctx, uint8_t *data_in, uint32_t len_in );
313 
325 
338 err_t excelonultra_write_byte_to_memory ( excelonultra_t *ctx, uint32_t mem_adr, uint8_t mem_data );
339 
354 ( excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data, uint32_t mem_data_len );
355 
369 ( excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data );
370 
385 ( excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data, uint32_t mem_data_len );
386 
398 err_t excelonultra_clear_byte_from_memory ( excelonultra_t *ctx, uint32_t mem_adr );
399 
413 ( excelonultra_t *ctx, uint32_t mem_adr, uint32_t mem_data_len );
414 
423 void excelonultra_set_rst_pin ( excelonultra_t *ctx, uint8_t state );
424 
433 void excelonultra_set_wp_pin ( excelonultra_t *ctx, uint8_t state );
434 
443 
444 #ifdef __cplusplus
445 }
446 #endif
447 #endif // EXCELONULTRA_H
448  // excelonultra
450 
451 // ------------------------------------------------------------------------ END
excelonultra_cfg_setup
void excelonultra_cfg_setup(excelonultra_cfg_t *cfg)
Excelon-Ultra configuration object setup function.
excelonultra_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: excelonultra.h:205
excelonultra_clear_byte_from_memory
err_t excelonultra_clear_byte_from_memory(excelonultra_t *ctx, uint32_t mem_adr)
Clear byte of data from specified memory address.
excelonultra_t::product_id
uint16_t product_id
Definition: excelonultra.h:180
excelonultra_cfg_t::sck
pin_name_t sck
Definition: excelonultra.h:195
EXCELONULTRA_OK
@ EXCELONULTRA_OK
Definition: excelonultra.h:215
excelonultra_generic_write
err_t excelonultra_generic_write(excelonultra_t *ctx, uint8_t *data_in, uint32_t len_in)
Excelon-Ultra data writing function.
excelonultra_t::wp
digital_out_t wp
Definition: excelonultra.h:170
excelonultra_t
Excelon-Ultra Click context object.
Definition: excelonultra.h:167
excelonultra_return_value_t
excelonultra_return_value_t
Excelon-Ultra Click return value data.
Definition: excelonultra.h:214
excelonultra_write_byte_to_memory
err_t excelonultra_write_byte_to_memory(excelonultra_t *ctx, uint32_t mem_adr, uint8_t mem_data)
Write byte of data to specified memory address.
excelonultra_cfg_t::rst
pin_name_t rst
Definition: excelonultra.h:199
excelonultra_get_device_identification
err_t excelonultra_get_device_identification(excelonultra_t *ctx)
Get device IDs.
excelonultra_t::chip_select
pin_name_t chip_select
Definition: excelonultra.h:175
excelonultra_read_byte_from_memory
err_t excelonultra_read_byte_from_memory(excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data)
Read byte of data from specified memory address.
excelonultra_set_wp_pin
void excelonultra_set_wp_pin(excelonultra_t *ctx, uint8_t state)
Set write protect pin state.
excelonultra_t::spi
spi_master_t spi
Definition: excelonultra.h:173
excelonultra_init
err_t excelonultra_init(excelonultra_t *ctx, excelonultra_cfg_t *cfg)
Excelon-Ultra initialization function.
excelonultra_cfg_t::spi_speed
uint32_t spi_speed
Definition: excelonultra.h:203
excelonultra_cfg_t::cs
pin_name_t cs
Definition: excelonultra.h:196
excelonultra_t::manufacturer_id
uint16_t manufacturer_id
Definition: excelonultra.h:179
excelonultra_generic_transfer
err_t excelonultra_generic_transfer(excelonultra_t *ctx, uint8_t *data_in, uint32_t len_in, uint8_t *data_out, uint32_t len_out)
Write-Read function.
excelonultra_hw_reset
void excelonultra_hw_reset(excelonultra_t *ctx)
Reset device.
excelonultra_cfg_t::mosi
pin_name_t mosi
Definition: excelonultra.h:194
excelonultra_t::density_id
uint8_t density_id
Definition: excelonultra.h:181
excelonultra_cfg_t::miso
pin_name_t miso
Definition: excelonultra.h:193
excelonultra_write_data_to_memory
err_t excelonultra_write_data_to_memory(excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data, uint32_t mem_data_len)
Write data starting from specified memory address.
EXCELONULTRA_ERROR
@ EXCELONULTRA_ERROR
Definition: excelonultra.h:216
excelonultra_set_rst_pin
void excelonultra_set_rst_pin(excelonultra_t *ctx, uint8_t state)
Set reset pin state.
excelonultra_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: excelonultra.h:204
excelonultra_read_data_from_memory
err_t excelonultra_read_data_from_memory(excelonultra_t *ctx, uint32_t mem_adr, uint8_t *mem_data, uint32_t mem_data_len)
Read data starting from specified memory address.
excelonultra_clear_data_from_memory
err_t excelonultra_clear_data_from_memory(excelonultra_t *ctx, uint32_t mem_adr, uint32_t mem_data_len)
Clears data starting from specified memory address.
excelonultra_send_cmd
err_t excelonultra_send_cmd(excelonultra_t *ctx, uint8_t cmd)
Send command.
excelonultra_t::rst
digital_out_t rst
Definition: excelonultra.h:169
excelonultra_cfg_t::wp
pin_name_t wp
Definition: excelonultra.h:200
excelonultra_default_cfg
err_t excelonultra_default_cfg(excelonultra_t *ctx)
Excelon-Ultra default configuration function.
excelonultra_cfg_t
Excelon-Ultra Click configuration object.
Definition: excelonultra.h:191
excelonultra_t::die_rev
uint8_t die_rev
Definition: excelonultra.h:182