nfcextend  2.0.0.0
nfcextend.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  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef NFCEXTEND_H
35 #define NFCEXTEND_H
36 
41 #ifdef PREINIT_SUPPORTED
42 #include "preinit.h"
43 #endif
44 
45 #ifdef MikroCCoreVersion
46  #if MikroCCoreVersion >= 1
47  #include "delays.h"
48  #endif
49 #endif
50 
51 #include "drv_digital_out.h"
52 #include "drv_digital_in.h"
53 #include "drv_i2c_master.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define NFCEXTEND_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
67  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
68  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
69 
75 #define NFCEXTEND_RETVAL uint8_t
76 
77 #define NFCEXTEND_OK 0x00
78 #define NFCEXTEND_INIT_ERROR 0xFF
79 
85 #define NFCEXTEND_I2C_SLAVE_ADDRESS 0x53
86 
92 // MEMORY AREAS
93 #define NFCEXTEND_MEMORY_USER 0x01
94 #define NFCEXTEND_MEMORY_DYNAMIC 0x02
95 #define NFCEXTEND_MEMORY_MAILBOX 0x03
96 #define NFCEXTEND_MEMORY_SYSTEM 0x04
97 
98 // SYSTEM REGISTER ADDRESSES
99 #define NFCEXTEND_SYSTEM_REG_GPO 0x0000
100 #define NFCEXTEND_SYSTEM_REG_IT_TIME 0x0001
101 #define NFCEXTEND_SYSTEM_REG_EH_MODE 0x0002
102 #define NFCEXTEND_SYSTEM_REG_RF_MNGT 0x0003
103 #define NFCEXTEND_SYSTEM_REG_RFA1SS 0x0004
104 #define NFCEXTEND_SYSTEM_REG_ENDA1 0x0005
105 #define NFCEXTEND_SYSTEM_REG_RFA2SS 0x0006
106 #define NFCEXTEND_SYSTEM_REG_ENDA2 0x0007
107 #define NFCEXTEND_SYSTEM_REG_RFA3SS 0x0008
108 #define NFCEXTEND_SYSTEM_REG_ENDA3 0x0009
109 #define NFCEXTEND_SYSTEM_REG_RFA4SS 0x000A
110 #define NFCEXTEND_SYSTEM_REG_I2CSS 0x000B
111 #define NFCEXTEND_SYSTEM_REG_LOCK_CCFILE 0x000C
112 #define NFCEXTEND_SYSTEM_REG_MB_MODE 0x000D
113 #define NFCEXTEND_SYSTEM_REG_MB_WDG 0x000E
114 #define NFCEXTEND_SYSTEM_REG_LOCK_CFG 0x000F
115 #define NFCEXTEND_SYSTEM_REG_LOCK_DSFID 0x0010
116 #define NFCEXTEND_SYSTEM_REG_LOCK_AFI 0x0011
117 #define NFCEXTEND_SYSTEM_REG_DSFID 0x0012
118 #define NFCEXTEND_SYSTEM_REG_AFI 0x0013
119 #define NFCEXTEND_SYSTEM_REG_MEM_SIZE_1 0x0014
120 #define NFCEXTEND_SYSTEM_REG_MEM_SIZE_2 0x0015
121 #define NFCEXTEND_SYSTEM_REG_BLK_SIZE 0x0016
122 #define NFCEXTEND_SYSTEM_REG_IC_REF 0x0017
123 #define NFCEXTEND_SYSTEM_REG_UID_1 0x0018
124 #define NFCEXTEND_SYSTEM_REG_UID_2 0x0019
125 #define NFCEXTEND_SYSTEM_REG_UID_3 0x001A
126 #define NFCEXTEND_SYSTEM_REG_UID_4 0x001B
127 #define NFCEXTEND_SYSTEM_REG_UID_5 0x001C
128 #define NFCEXTEND_SYSTEM_REG_UID_6 0x001D
129 #define NFCEXTEND_SYSTEM_REG_UID_7 0x001E
130 #define NFCEXTEND_SYSTEM_REG_UID_8 0x001F
131 #define NFCEXTEND_SYSTEM_REG_IC_REV 0x0020
132 #define NFCEXTEND_SYSTEM_REG_ST_RES_1 0x0021
133 #define NFCEXTEND_SYSTEM_REG_ST_RES_2 0x0022
134 #define NFCEXTEND_SYSTEM_REG_ST_RES_3 0x0023
135 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_1 0x0900
136 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_2 0x0901
137 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_3 0x0902
138 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_4 0x0903
139 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_5 0x0904
140 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_6 0x0905
141 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_7 0x0906
142 #define NFCEXTEND_SYSTEM_REG_I2C_PWD_8 0x0907
143 
144 // DYNAMIC REGISTER ADDRESSES
145 #define NFCEXTEND_DYNAMIC_REG_GPO_CTRL 0x2000
146 #define NFCEXTEND_DYNAMIC_REG_RESERVED_1 0x2001
147 #define NFCEXTEND_DYNAMIC_REG_EH_CTRL 0x2002
148 #define NFCEXTEND_DYNAMIC_REG_RF_MNGT 0x2003
149 #define NFCEXTEND_DYNAMIC_REG_I2C_SSO 0x2004
150 #define NFCEXTEND_DYNAMIC_REG_IT_STS 0x2005
151 #define NFCEXTEND_DYNAMIC_REG_MB_CTRL 0x2006
152 #define NFCEXTEND_DYNAMIC_REG_MB_LEN 0x2007
153 
159 // MAILBOX REGISTER ADDRESSES
160 #define NFCEXTEND_MAILBOX_REG_BYTE_0 0x2008
161 
162 // MAILBOX ENABLE/DISABLE
163 #define NFCEXTEND_MAILBOX_DISABLE 0x00
164 #define NFCEXTEND_MAILBOX_ENABLE 0x01
165 
166 // RF ENABLE/DISABLE
167 #define NFCEXTEND_RF_DISABLE 0x00
168 #define NFCEXTEND_RF_ENABLE 0x01
169 
170 // PASSWORD PRESENT
171 #define NFCEXTEND_PASSWORD_LEN 8
172 #define NFCEXTEND_PASSWORD_BUFFER_SIZE NFCEXTEND_PASSWORD_LEN * 2 + 1
173  // End group macro
176 // --------------------------------------------------------------- PUBLIC TYPES
185 typedef struct
186 {
187  uint8_t memory_area;
188  uint16_t reg_addr;
189  uint8_t *data_buf;
190  uint16_t len;
191 
193 
197 typedef struct
198 {
199  // Input pins
200 
201  digital_in_t int_pin;
202 
203  // Modules
204 
205  i2c_master_t i2c;
206 
207  // ctx variable
208 
209  uint8_t slave_address;
210 
211 } nfcextend_t;
212 
216 typedef struct
217 {
218  // Communication gpio pins
219 
220  pin_name_t scl;
221  pin_name_t sda;
222 
223  // Additional gpio pins
224 
225  pin_name_t int_pin;
226 
227  // static variable
228 
229  uint32_t i2c_speed;
230  uint8_t i2c_address;
231 
233  // End types group
235 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
236 
242 #ifdef __cplusplus
243 extern "C"{
244 #endif
245 
255 
264 
273 
282 uint8_t nfcextend_password_present ( nfcextend_t *ctx, uint8_t *pass_buf );
283 
293 
303 
313 
314 #ifdef __cplusplus
315 }
316 #endif
317 #endif // _NFCEXTEND_H_
318  // End public_function group
321 
322 // ------------------------------------------------------------------------- END
nfcextend_cfg_t::int_pin
pin_name_t int_pin
Definition: nfcextend.h:225
nfcextend_default_cfg
uint8_t nfcextend_default_cfg(nfcextend_t *ctx)
Click Default Configuration function.
nfcextend_cfg_setup
void nfcextend_cfg_setup(nfcextend_cfg_t *cfg)
Config Object Initialization function.
nfcextend_t::slave_address
uint8_t slave_address
Definition: nfcextend.h:209
nfcextend_t::int_pin
digital_in_t int_pin
Definition: nfcextend.h:201
nfcextend_t
Click ctx object definition.
Definition: nfcextend.h:198
nfcextend_i2c_get
uint8_t nfcextend_i2c_get(nfcextend_t *ctx, nfcextend_block_t *block)
I2C get function.
nfcextend_block_t::memory_area
uint8_t memory_area
Definition: nfcextend.h:187
nfcextend_init
NFCEXTEND_RETVAL nfcextend_init(nfcextend_t *ctx, nfcextend_cfg_t *cfg)
Initialization function.
nfcextend_password_present
uint8_t nfcextend_password_present(nfcextend_t *ctx, uint8_t *pass_buf)
Password present function.
nfcextend_cfg_t
Click configuration structure definition.
Definition: nfcextend.h:217
nfcextend_block_t::reg_addr
uint16_t reg_addr
Definition: nfcextend.h:188
nfcextend_block_t::data_buf
uint8_t * data_buf
Definition: nfcextend.h:189
nfcextend_block_t::len
uint16_t len
Definition: nfcextend.h:190
nfcextend_cfg_t::sda
pin_name_t sda
Definition: nfcextend.h:221
nfcextend_i2c_set
uint8_t nfcextend_i2c_set(nfcextend_t *ctx, nfcextend_block_t *block)
I2C set function.
nfcextend_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: nfcextend.h:229
nfcextend_cfg_t::i2c_address
uint8_t i2c_address
Definition: nfcextend.h:230
NFCEXTEND_RETVAL
#define NFCEXTEND_RETVAL
Definition: nfcextend.h:75
nfcextend_t::i2c
i2c_master_t i2c
Definition: nfcextend.h:205
nfcextend_cfg_t::scl
pin_name_t scl
Definition: nfcextend.h:220
nfcextend_digital_read_int
uint8_t nfcextend_digital_read_int(nfcextend_t *ctx)
Digital read interrupt.
nfcextend_block_t
I2C communication block object definition.
Definition: nfcextend.h:186