ltecat12 2.1.0.0
ltecat12.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 LTECAT12_H
29#define LTECAT12_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38#include "drv_uart.h"
39
60#define LTECAT12_MAX9860_REG_INTR_STATS 0x00
61#define LTECAT12_MAX9860_REG_MIC_NG_AGC 0x01
62#define LTECAT12_MAX9860_REG_INTR_EN 0x02
63#define LTECAT12_MAX9860_REG_SYS_CLK 0x03
64#define LTECAT12_MAX9860_REG_STEREO_CLK_MSB 0x04
65#define LTECAT12_MAX9860_REG_STEREO_CLK_LSB 0x05
66#define LTECAT12_MAX9860_REG_AUDIO_INTERFACE_1 0x06
67#define LTECAT12_MAX9860_REG_AUDIO_INTERFACE_2 0x07
68#define LTECAT12_MAX9860_REG_VOICE_FILTER 0x08
69#define LTECAT12_MAX9860_REG_DAC_ATTENUATION 0x09
70#define LTECAT12_MAX9860_REG_ADC_OUTPUT_LEVELS 0x0A
71#define LTECAT12_MAX9860_REG_DAC_GAIN 0x0B
72#define LTECAT12_MAX9860_REG_MIC_GAIN 0x0C
73#define LTECAT12_MAX9860_REG_MIC_AGC 0x0E
74#define LTECAT12_MAX9860_REG_NOISE_GATE 0x0F
75#define LTECAT12_MAX9860_REG_SYS_SHUTDOWN 0x10
76
81#define LTECAT12_CMD_AT "AT"
82#define LTECAT12_CMD_ATI "ATI"
83#define LTECAT12_CMD_CFUN "AT+CFUN"
84#define LTECAT12_CMD_CREG "AT+CREG"
85#define LTECAT12_CMD_CGDCONT "AT+CGDCONT"
86#define LTECAT12_CMD_CESQ "AT+CESQ"
87#define LTECAT12_CMD_COPS "AT+COPS"
88#define LTECAT12_CMD_CMGS "AT+CMGS"
89#define LTECAT12_CMD_CMGF "AT+CMGF"
90#define LTECAT12_CMD_CGPADDR "AT+CGPADDR"
91#define LTECAT12_CMD_SICA "AT^SICA"
92#define LTECAT12_CMD_SISS "AT^SISS"
93#define LTECAT12_CMD_SISO "AT^SISO"
94#define LTECAT12_CMD_SISW "AT^SISW"
95#define LTECAT12_CMD_SISR "AT^SISR"
96#define LTECAT12_CMD_SISC "AT^SISC"
97#define LTECAT12_CMD_SGPSC "AT^SGPSC"
98#define LTECAT12_CMD_CHUP "AT+CHUP"
99#define LTECAT12_CMD_SCFG "AT^SCFG"
100#define LTECAT12_CMD_SAIC "AT^SAIC"
101#define LTECAT12_CMD_SNFS "AT^SNFS"
102#define LTECAT12_CMD_ATD "ATD"
103
108#define LTECAT12_PSCLK_12MHZ 0x10
109#define LTECAT12_LRCLK_8MHZ_MSB 0x10
110#define LTECAT12_LRCLK_8MHZ_LSB 0x00
111#define LTECAT12_DBCI_FALLING_EDGE 0x20
112#define LTECAT12_HIZ_ENABLE 0x08
113#define LTECAT12_TDM_ENABLE 0x04
114#define LTECAT12_ABCI_FALLING_EDGE 0x20
115#define LTECAT12_ADLY_ENABLE 0x10
116#define LTECAT12_STEREO_ENABLE 0x08
117#define LTECAT12_AVFLT_DISABLE 0x00
118#define LTECAT12_DVFLT_DISABLE 0x00
119#define LTECAT12_DVA_GAIN_0 0x06
120#define LTECAT12_ADC_GAIN_3 0x00
121#define LTECAT12_DAC_GAIN_0 0x00
122#define LTECAT12_DVST_GAIN_0 0x01
123#define LTECAT12_MIC_GAIN_0 0x20
124#define LTECAT12_PGAM_GAIN_0 0x14
125#define LTECAT12_AGCSRC_ENABLE 0x80
126#define LTECAT12_ANTH_DISABLE 0x00
127#define LTECAT12_AGCTH_MINUS_3 0x00
128#define LTECAT12_POWER_ON 0x80
129#define LTECAT12_DAC_ENABLE 0x08
130#define LTECAT12_ADCL_ADCR_ENABLE 0x03
131
136#define LTECAT12_PIN_STATE_HIGH 0x01
137#define LTECAT12_PIN_STATE_LOW 0x00
138
143#define LTECAT12_RSP_OK "OK"
144#define LTECAT12_RSP_ERROR "ERROR"
145#define LTECAT12_RSP_SYSSTART "^SYSSTART"
146
151#define LTECAT12_POWER_STATE_SWITCH 0
152#define LTECAT12_POWER_STATE_ON 1
153#define LTECAT12_POWER_STATE_REBOOT 2
154
160#define LTECAT12_TX_DRV_BUFFER_SIZE 200
161#define LTECAT12_RX_DRV_BUFFER_SIZE 300
162
168#define LTECAT12_ADDRESS 0x10
169 // ltecat12_cmd
171
186#define LTECAT12_MAP_MIKROBUS( cfg, mikrobus ) \
187 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
188 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
189 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
190 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
191 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
192 cfg.fsd = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
193 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
194 // ltecat12_map // ltecat12
197
202typedef struct
203{
204 // Output pins
205 digital_out_t rts;
206 digital_out_t fsd;
208 // Input pins
209 digital_in_t cts;
211 // Modules
212 i2c_master_t i2c;
213 uart_t uart;
215 // I2C slave address
218 // Buffers
219 uint8_t uart_rx_buffer[ LTECAT12_RX_DRV_BUFFER_SIZE ];
220 uint8_t uart_tx_buffer[ LTECAT12_TX_DRV_BUFFER_SIZE ];
222} ltecat12_t;
223
228typedef struct
229{
230 // Communication gpio pins
231 pin_name_t rx_pin;
232 pin_name_t tx_pin;
233 pin_name_t scl;
234 pin_name_t sda;
236 // Additional gpio pins
237 pin_name_t cts;
238 pin_name_t fsd;
239 pin_name_t rts;
241 // Static variable
242 uint32_t baud_rate;
244 uart_data_bits_t data_bit;
245 uart_parity_t parity_bit;
246 uart_stop_bits_t stop_bit;
247 uint32_t i2c_speed;
248 uint8_t i2c_address;
251
256typedef enum
257{
263
265
282
297
310err_t ltecat12_generic_write ( ltecat12_t *ctx, uint8_t *data_in, uint16_t len );
311
324err_t ltecat12_generic_read ( ltecat12_t *ctx, uint8_t *data_out, uint16_t len );
325
338err_t ltecat12_write_register ( ltecat12_t *ctx, uint8_t reg, uint8_t data_in );
339
352err_t ltecat12_read_register ( ltecat12_t *ctx, uint8_t reg, uint8_t *data_out );
353
366
376void ltecat12_set_fsd_pin ( ltecat12_t *ctx, uint8_t state );
377
387void ltecat12_set_rts_pin ( ltecat12_t *ctx, uint8_t state );
388
398
408void ltecat12_send_cmd ( ltecat12_t *ctx, uint8_t *cmd );
409
420void ltecat12_send_cmd_with_parameter ( ltecat12_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
421
431void ltecat12_send_cmd_check ( ltecat12_t *ctx, uint8_t *at_cmd_buf );
432
442void ltecat12_send_cmd_parameter_check ( ltecat12_t *ctx, uint8_t *at_cmd_buf );
443
453void ltecat12_set_sim_apn ( ltecat12_t *ctx, uint8_t *sim_apn );
454
465void ltecat12_send_sms_text ( ltecat12_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
466
480err_t ltecat12_send_sms_pdu ( ltecat12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
481
482#ifdef __cplusplus
483}
484#endif
485#endif // LTECAT12_H
486 // ltecat12
488
489// ------------------------------------------------------------------------ END
#define LTECAT12_RX_DRV_BUFFER_SIZE
Definition: ltecat12.h:161
#define LTECAT12_TX_DRV_BUFFER_SIZE
LTE Cat.1 2 driver buffer size.
Definition: ltecat12.h:160
err_t ltecat12_read_register(ltecat12_t *ctx, uint8_t reg, uint8_t *data_out)
LTE Cat.1 2 MAX9860 reading function.
err_t ltecat12_init(ltecat12_t *ctx, ltecat12_cfg_t *cfg)
LTE Cat.1 2 initialization function.
err_t ltecat12_generic_write(ltecat12_t *ctx, uint8_t *data_in, uint16_t len)
LTE Cat.1 2 data writing function.
err_t ltecat12_max9860_cfg(ltecat12_t *ctx)
LTE Cat.1 2 MAX9860 configuration function.
void ltecat12_cfg_setup(ltecat12_cfg_t *cfg)
LTE Cat.1 2 configuration object setup function.
err_t ltecat12_write_register(ltecat12_t *ctx, uint8_t reg, uint8_t data_in)
LTE Cat.1 2 MAX9860 writing function.
void ltecat12_send_cmd_check(ltecat12_t *ctx, uint8_t *at_cmd_buf)
LTE Cat.1 2 check the sent command.
void ltecat12_set_fsd_pin(ltecat12_t *ctx, uint8_t state)
LTE Cat.1 2 set fsd pin function.
void ltecat12_set_sim_apn(ltecat12_t *ctx, uint8_t *sim_apn)
LTE Cat.1 2 set sim card APN.
err_t ltecat12_generic_read(ltecat12_t *ctx, uint8_t *data_out, uint16_t len)
LTE Cat.1 2 data reading function.
void ltecat12_send_sms_text(ltecat12_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 2 send SMS in text mode.
void ltecat12_send_cmd_parameter_check(ltecat12_t *ctx, uint8_t *at_cmd_buf)
LTE Cat.1 2 check the command parameters.
void ltecat12_send_cmd(ltecat12_t *ctx, uint8_t *cmd)
LTE Cat.1 2 send command function.
err_t ltecat12_send_sms_pdu(ltecat12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 2 send SMS in PDU mode.
void ltecat12_send_cmd_with_parameter(ltecat12_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
LTE Cat.1 2 send command function with parameter.
uint8_t ltecat12_get_cts_pin(ltecat12_t *ctx)
LTE Cat.1 2 get cts pin function.
void ltecat12_set_rts_pin(ltecat12_t *ctx, uint8_t state)
LTE Cat.1 2 set rts pin function.
ltecat12_return_value_t
LTE Cat.1 2 Click return value data.
Definition: ltecat12.h:257
@ LTECAT12_ERROR_CMD
Definition: ltecat12.h:261
@ LTECAT12_ERROR_TIMEOUT
Definition: ltecat12.h:260
@ LTECAT12_ERROR
Definition: ltecat12.h:259
@ LTECAT12_ERROR_UNKNOWN
Definition: ltecat12.h:262
@ LTECAT12_OK
Definition: ltecat12.h:258
LTE Cat.1 2 Click configuration object.
Definition: ltecat12.h:229
pin_name_t rts
Definition: ltecat12.h:239
uint32_t baud_rate
Definition: ltecat12.h:242
pin_name_t cts
Definition: ltecat12.h:237
uint32_t i2c_speed
Definition: ltecat12.h:247
bool uart_blocking
Definition: ltecat12.h:243
uart_data_bits_t data_bit
Definition: ltecat12.h:244
pin_name_t tx_pin
Definition: ltecat12.h:232
pin_name_t fsd
Definition: ltecat12.h:238
pin_name_t rx_pin
Definition: ltecat12.h:231
uart_stop_bits_t stop_bit
Definition: ltecat12.h:246
pin_name_t scl
Definition: ltecat12.h:233
uart_parity_t parity_bit
Definition: ltecat12.h:245
pin_name_t sda
Definition: ltecat12.h:234
uint8_t i2c_address
Definition: ltecat12.h:248
LTE Cat.1 2 Click context object.
Definition: ltecat12.h:203
digital_out_t fsd
Definition: ltecat12.h:206
digital_out_t rts
Definition: ltecat12.h:205
uart_t uart
Definition: ltecat12.h:213
i2c_master_t i2c
Definition: ltecat12.h:212
digital_in_t cts
Definition: ltecat12.h:209
uint8_t slave_address
Definition: ltecat12.h:216