clickid  2.1.0.0
clickid.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 CLICKID_H
29 #define CLICKID_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_one_wire.h"
48 
69 #define CLICKID_CMD_WRITE_MEMORY 0x96
70 #define CLICKID_CMD_READ_MEMORY 0x69
71 #define CLICKID_CMD_RELEASE 0xAA
72  // clickid_cmd
74 
89 #define CLICKID_MEM_ACCESS_SUCCESS 0xAA
90 #define CLICKID_MEM_ACCESS_FAIL 0x55
91 
96 #define CLICKID_USER_EEPROM_START 0x0000
97 #define CLICKID_USER_EEPROM_END 0x01FF
98 #define CLICKID_PAGE_START 0x00
99 #define CLICKID_PAGE_END 0x1F
100 #define CLICKID_PAGE_SIZE 32
101 #define CLICKID_MANIFEST_START_ADDRESS 0x0020
102 
107 #define CLICKID_FAMILY_CODE 0xCC
108  // clickid_set
110 
125 #define CLICKID_MAP_MIKROBUS( cfg, mikrobus ) \
126  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
127  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
128  // clickid_map // clickid
131 
136 typedef struct
137 {
138  uint8_t major;
139  uint8_t minor;
140 
142 
147 typedef struct
148 {
150  uint16_t serial;
151  uint16_t type;
152  uint8_t custom;
153  uint8_t name[ 20 ];
156 
161 typedef struct
162 {
163  // Output pins
164  digital_out_t rst;
166  // Modules
167  one_wire_t ow;
169  one_wire_rom_address_t rom_addr;
171 } clickid_t;
172 
177 typedef struct
178 {
179  // Communication gpio pins
180  pin_name_t cs;
182  // Additional gpio pins
183  pin_name_t rst;
185 } clickid_cfg_t;
186 
191 typedef enum
192 {
194  CLICKID_ERROR = -1
195 
197 
214 
228 err_t clickid_init ( clickid_t *ctx, clickid_cfg_t *cfg );
229 
238 void clickid_deinit ( clickid_t *ctx );
239 
252 
267 err_t clickid_read_memory ( clickid_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );
268 
283 err_t clickid_write_memory ( clickid_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len );
284 
298 
299 #ifdef __cplusplus
300 }
301 #endif
302 #endif // CLICKID_H
303  // clickid
305 
306 // ------------------------------------------------------------------------ END
clickid_information_t
ClickID information.
Definition: clickid.h:148
clickid_write_memory
err_t clickid_write_memory(clickid_t *ctx, uint16_t address, uint8_t *data_in, uint16_t len)
ClickID write memory function.
clickid_cfg_t
ClickID configuration object.
Definition: clickid.h:178
CLICKID_OK
@ CLICKID_OK
Definition: clickid.h:193
clickid_version_t::minor
uint8_t minor
Definition: clickid.h:139
clickid_deinit
void clickid_deinit(clickid_t *ctx)
ClickID de-initialization function.
clickid_cfg_setup
void clickid_cfg_setup(clickid_cfg_t *cfg)
ClickID configuration object setup function.
clickid_cfg_t::rst
pin_name_t rst
Definition: clickid.h:183
clickid_check_communication
err_t clickid_check_communication(clickid_t *ctx)
ClickID check communication function.
clickid_read_memory
err_t clickid_read_memory(clickid_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len)
ClickID read memory function.
clickid_information_t::custom
uint8_t custom
Definition: clickid.h:152
clickid_information_t::hw_rev
clickid_version_t hw_rev
Definition: clickid.h:149
CLICKID_ERROR
@ CLICKID_ERROR
Definition: clickid.h:194
clickid_return_value_t
clickid_return_value_t
ClickID return value data.
Definition: clickid.h:192
clickid_t::ow
one_wire_t ow
Definition: clickid.h:167
clickid_information_t::type
uint16_t type
Definition: clickid.h:151
clickid_read_information
err_t clickid_read_information(clickid_t *ctx, clickid_information_t *info)
ClickID read information function.
clickid_version_t
ClickID version.
Definition: clickid.h:137
clickid_information_t::serial
uint16_t serial
Definition: clickid.h:150
clickid_cfg_t::cs
pin_name_t cs
Definition: clickid.h:180
clickid_version_t::major
uint8_t major
Definition: clickid.h:138
clickid_init
err_t clickid_init(clickid_t *ctx, clickid_cfg_t *cfg)
ClickID initialization function.
clickid_t::rom_addr
one_wire_rom_address_t rom_addr
Definition: clickid.h:169
clickid_t::rst
digital_out_t rst
Definition: clickid.h:164
clickid_t
ClickID context object.
Definition: clickid.h:162