bm78 2.1.0.0
bm78.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 BM78_H
29#define BM78_H
30
31#ifdef __cplusplus
32extern "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_uart.h"
48#include "bm78_config.h"
49
70#define BM78_HCI_COMMAND_PACKET 0x01
71#define BM78_HCI_ACL_DATA_PACKET 0x02
72#define BM78_HCI_SYNCHRONOUS_DATA_PACKET 0x03
73#define BM78_HCI_EVENT_PACKET 0x04
74#define BM78_HCI_ISO_DATA_PACKET 0x05
75#define BM78_HCI_COMMAND_COMPLETE 0x0E
76#define BM78_HCI_COMMAND_IND_SUCCESS 0x00
77
82#define BM78_PAGE_WRITE_NUMBER 0x08
83
88#define BM78_PIN_STATE_HIGH 0x01
89#define BM78_PIN_STATE_LOW 0x00
90
95#define BM78_OPCODE_RESET_CMD 0x030C
96#define BM78_HCI_EEPROM_WR_PG_NUM_CMD 0x2DFC
97#define BM78_HCI_EEPROM_WRITE_CMD 0x27FC
98#define BM78_HCI_EEPROM_READ_CMD 0x29FC
99
105#define BM78_TX_DRV_BUFFER_SIZE 100
106#define BM78_RX_DRV_BUFFER_SIZE 300
107 // bm78_cmd
109
124#define BM78_MAP_MIKROBUS( cfg, mikrobus ) \
125 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
126 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
127 cfg.st1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
128 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
129 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
130 cfg.st2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
131 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
132 // bm78_map // bm78
135
140typedef struct
141{
142 // Output pins
143 digital_out_t rst;
144 digital_out_t cts;
146 // Input pins
147 digital_in_t st1;
148 digital_in_t st2;
149 digital_in_t rts;
151 // Modules
152 uart_t uart;
154 // Buffers
155 uint8_t uart_rx_buffer[ BM78_RX_DRV_BUFFER_SIZE ];
156 uint8_t uart_tx_buffer[ BM78_TX_DRV_BUFFER_SIZE ];
158} bm78_t;
159
164typedef struct
165{
166 // Communication gpio pins
167 pin_name_t rx_pin;
168 pin_name_t tx_pin;
170 // Additional gpio pins
171 pin_name_t st1;
172 pin_name_t rst;
173 pin_name_t cts;
174 pin_name_t st2;
175 pin_name_t rts;
177 // Static variable
178 uint32_t baud_rate;
180 uart_data_bits_t data_bit;
181 uart_parity_t parity_bit;
182 uart_stop_bits_t stop_bit;
184} bm78_cfg_t;
185
190typedef enum
191{
193 BM78_ERROR = -1
194
196
213
227err_t bm78_init ( bm78_t *ctx, bm78_cfg_t *cfg );
228
241err_t bm78_generic_write ( bm78_t *ctx, uint8_t *data_in, uint16_t len );
242
255err_t bm78_generic_read ( bm78_t *ctx, uint8_t *data_out, uint16_t len );
256
266void bm78_set_rst_pin ( bm78_t *ctx, uint8_t pin_state );
267
277void bm78_set_cts_pin ( bm78_t *ctx, uint8_t pin_state );
278
288uint8_t bm78_get_st1_pin ( bm78_t *ctx );
289
299uint8_t bm78_get_st2_pin ( bm78_t *ctx );
300
310uint8_t bm78_get_rts_pin ( bm78_t *ctx );
311
320void bm78_hw_reset ( bm78_t *ctx );
321
335err_t bm78_eeprom_send_cmd ( bm78_t *ctx, uint16_t op_code, uint8_t *param, uint8_t len );
336
350err_t bm78_eeprom_get_event ( bm78_t *ctx, uint8_t *ev_type, uint8_t *len, uint8_t *data_rx );
351
362err_t bm78_reset_cmd ( bm78_t *ctx );
363
375
390err_t bm78_eeprom_write ( bm78_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );
391
407err_t bm78_eeprom_read ( bm78_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len );
408
420
421#ifdef __cplusplus
422}
423#endif
424#endif // BM78_H
425 // bm78
427
428// ------------------------------------------------------------------------ END
bm78_return_value_t
BM78 Click return value data.
Definition: bm78.h:191
@ BM78_ERROR
Definition: bm78.h:193
@ BM78_OK
Definition: bm78.h:192
#define BM78_TX_DRV_BUFFER_SIZE
BM78 driver buffer size.
Definition: bm78.h:105
#define BM78_RX_DRV_BUFFER_SIZE
Definition: bm78.h:106
err_t bm78_generic_write(bm78_t *ctx, uint8_t *data_in, uint16_t len)
BM78 data writing function.
err_t bm78_reset_cmd(bm78_t *ctx)
BM78 reset function.
err_t bm78_eeprom_get_event(bm78_t *ctx, uint8_t *ev_type, uint8_t *len, uint8_t *data_rx)
BM78 EEPROM get event function.
err_t bm78_generic_read(bm78_t *ctx, uint8_t *data_out, uint16_t len)
BM78 data reading function.
err_t bm78_init(bm78_t *ctx, bm78_cfg_t *cfg)
BM78 initialization function.
void bm78_set_cts_pin(bm78_t *ctx, uint8_t pin_state)
BM78 set CTS pin function.
err_t bm78_eeprom_write_number(bm78_t *ctx)
BM78 write EEPROM number function.
void bm78_cfg_setup(bm78_cfg_t *cfg)
BM78 configuration object setup function.
void bm78_set_rst_pin(bm78_t *ctx, uint8_t pin_state)
BM78 set RST pin function.
uint8_t bm78_get_st2_pin(bm78_t *ctx)
BM78 get ST2 pin function.
err_t bm78_flash_eeprom(bm78_t *ctx)
BM78 EEPROM flash function.
err_t bm78_eeprom_send_cmd(bm78_t *ctx, uint16_t op_code, uint8_t *param, uint8_t len)
BM78 EEPROM send command function.
err_t bm78_eeprom_read(bm78_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len)
BM78 EEPROM read function.
void bm78_hw_reset(bm78_t *ctx)
BM78 Hardware reset function.
uint8_t bm78_get_st1_pin(bm78_t *ctx)
BM78 get ST1 pin function.
uint8_t bm78_get_rts_pin(bm78_t *ctx)
BM78 get RTS pin function.
err_t bm78_eeprom_write(bm78_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len)
BM78 EEPROM write function.
BM78 Click configuration object.
Definition: bm78.h:165
pin_name_t rts
Definition: bm78.h:175
uint32_t baud_rate
Definition: bm78.h:178
pin_name_t cts
Definition: bm78.h:173
pin_name_t st1
Definition: bm78.h:171
bool uart_blocking
Definition: bm78.h:179
uart_data_bits_t data_bit
Definition: bm78.h:180
pin_name_t tx_pin
Definition: bm78.h:168
pin_name_t st2
Definition: bm78.h:174
pin_name_t rx_pin
Definition: bm78.h:167
uart_stop_bits_t stop_bit
Definition: bm78.h:182
uart_parity_t parity_bit
Definition: bm78.h:181
pin_name_t rst
Definition: bm78.h:172
BM78 Click context object.
Definition: bm78.h:141
digital_in_t st2
Definition: bm78.h:148
uart_t uart
Definition: bm78.h:152
digital_in_t st1
Definition: bm78.h:147
digital_in_t rts
Definition: bm78.h:149
digital_out_t rst
Definition: bm78.h:143
digital_out_t cts
Definition: bm78.h:144