ltecat12.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef LTECAT12_H
#define LTECAT12_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"
 
#define LTECAT12_MAX9860_REG_INTR_STATS             0x00
#define LTECAT12_MAX9860_REG_MIC_NG_AGC             0x01
#define LTECAT12_MAX9860_REG_INTR_EN                0x02
#define LTECAT12_MAX9860_REG_SYS_CLK                0x03
#define LTECAT12_MAX9860_REG_STEREO_CLK_MSB         0x04
#define LTECAT12_MAX9860_REG_STEREO_CLK_LSB         0x05
#define LTECAT12_MAX9860_REG_AUDIO_INTERFACE_1      0x06
#define LTECAT12_MAX9860_REG_AUDIO_INTERFACE_2      0x07
#define LTECAT12_MAX9860_REG_VOICE_FILTER           0x08
#define LTECAT12_MAX9860_REG_DAC_ATTENUATION        0x09
#define LTECAT12_MAX9860_REG_ADC_OUTPUT_LEVELS      0x0A
#define LTECAT12_MAX9860_REG_DAC_GAIN               0x0B
#define LTECAT12_MAX9860_REG_MIC_GAIN               0x0C
#define LTECAT12_MAX9860_REG_MIC_AGC                0x0E
#define LTECAT12_MAX9860_REG_NOISE_GATE             0x0F
#define LTECAT12_MAX9860_REG_SYS_SHUTDOWN           0x10
 
#define LTECAT12_CMD_AT                             "AT"
#define LTECAT12_CMD_ATI                            "ATI"
#define LTECAT12_CMD_CFUN                           "AT+CFUN"
#define LTECAT12_CMD_CREG                           "AT+CREG"
#define LTECAT12_CMD_CGDCONT                        "AT+CGDCONT"
#define LTECAT12_CMD_CESQ                           "AT+CESQ"
#define LTECAT12_CMD_COPS                           "AT+COPS"
#define LTECAT12_CMD_CMGS                           "AT+CMGS"
#define LTECAT12_CMD_CMGF                           "AT+CMGF"
#define LTECAT12_CMD_CGPADDR                        "AT+CGPADDR"
#define LTECAT12_CMD_SICA                           "AT^SICA"
#define LTECAT12_CMD_SISS                           "AT^SISS"
#define LTECAT12_CMD_SISO                           "AT^SISO"
#define LTECAT12_CMD_SISW                           "AT^SISW"
#define LTECAT12_CMD_SISR                           "AT^SISR"
#define LTECAT12_CMD_SISC                           "AT^SISC"
#define LTECAT12_CMD_SGPSC                          "AT^SGPSC"
#define LTECAT12_CMD_CHUP                           "AT+CHUP"
#define LTECAT12_CMD_SCFG                           "AT^SCFG"
#define LTECAT12_CMD_SAIC                           "AT^SAIC"
#define LTECAT12_CMD_SNFS                           "AT^SNFS"
#define LTECAT12_CMD_ATD                            "ATD"
 
#define LTECAT12_PSCLK_12MHZ                        0x10
#define LTECAT12_LRCLK_8MHZ_MSB                     0x10
#define LTECAT12_LRCLK_8MHZ_LSB                     0x00
#define LTECAT12_DBCI_FALLING_EDGE                  0x20
#define LTECAT12_HIZ_ENABLE                         0x08
#define LTECAT12_TDM_ENABLE                         0x04
#define LTECAT12_ABCI_FALLING_EDGE                  0x20
#define LTECAT12_ADLY_ENABLE                        0x10
#define LTECAT12_STEREO_ENABLE                      0x08
#define LTECAT12_AVFLT_DISABLE                      0x00
#define LTECAT12_DVFLT_DISABLE                      0x00
#define LTECAT12_DVA_GAIN_0                         0x06
#define LTECAT12_ADC_GAIN_3                         0x00
#define LTECAT12_DAC_GAIN_0                         0x00
#define LTECAT12_DVST_GAIN_0                        0x01
#define LTECAT12_MIC_GAIN_0                         0x20
#define LTECAT12_PGAM_GAIN_0                        0x14
#define LTECAT12_AGCSRC_ENABLE                      0x80
#define LTECAT12_ANTH_DISABLE                       0x00
#define LTECAT12_AGCTH_MINUS_3                      0x00
#define LTECAT12_POWER_ON                           0x80
#define LTECAT12_DAC_ENABLE                         0x08
#define LTECAT12_ADCL_ADCR_ENABLE                   0x03
 
#define LTECAT12_PIN_STATE_HIGH                     0x01
#define LTECAT12_PIN_STATE_LOW                      0x00
 
#define LTECAT12_RSP_OK                              "OK"
#define LTECAT12_RSP_ERROR                           "ERROR"
#define LTECAT12_RSP_SYSSTART                        "^SYSSTART"
 
#define LTECAT12_POWER_STATE_SWITCH                  0
#define LTECAT12_POWER_STATE_ON                      1
#define LTECAT12_POWER_STATE_REBOOT                  2
 
#define LTECAT12_TX_DRV_BUFFER_SIZE                 300
#define LTECAT12_RX_DRV_BUFFER_SIZE                 300
 
#define LTECAT12_ADDRESS                            0x10
 
 // ltecat12_cmd
 
#define LTECAT12_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.fsd = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // ltecat12_map
 // ltecat12
 
typedef struct
{
    // Output pins
    digital_out_t rts;                  
    digital_out_t fsd;                  
    // Input pins
    digital_in_t cts;                   
    // Modules
    i2c_master_t i2c;                   
    uart_t uart;                        
    // I2C slave address
    uint8_t slave_address;              
    // Buffers
    uint8_t uart_rx_buffer[ LTECAT12_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ LTECAT12_TX_DRV_BUFFER_SIZE ];  
} ltecat12_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                  
    pin_name_t tx_pin;                  
    pin_name_t scl;                     
    pin_name_t sda;                     
    // Additional gpio pins
    pin_name_t cts;                     
    pin_name_t fsd;                     
    pin_name_t rts;                     
    // Static variable
    uint32_t         baud_rate;         
    bool             uart_blocking;     
    uart_data_bits_t data_bit;          
    uart_parity_t    parity_bit;        
    uart_stop_bits_t stop_bit;          
    uint32_t   i2c_speed;               
    uint8_t    i2c_address;             
} ltecat12_cfg_t;
 
typedef enum
{
    LTECAT12_OK = 0,
    LTECAT12_ERROR = -1,
    LTECAT12_ERROR_TIMEOUT = -2,
    LTECAT12_ERROR_CMD = -3,
    LTECAT12_ERROR_UNKNOWN = -4
 
} ltecat12_return_value_t;
 
void ltecat12_cfg_setup ( ltecat12_cfg_t *cfg );
 
err_t ltecat12_init ( ltecat12_t *ctx, ltecat12_cfg_t *cfg );
 
err_t ltecat12_generic_write ( ltecat12_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t ltecat12_generic_read ( ltecat12_t *ctx, uint8_t *data_out, uint16_t len );
 
err_t ltecat12_write_register ( ltecat12_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ltecat12_read_register ( ltecat12_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t ltecat12_max9860_cfg ( ltecat12_t *ctx );
 
void ltecat12_set_fsd_pin ( ltecat12_t *ctx, uint8_t state );
 
void ltecat12_set_rts_pin ( ltecat12_t *ctx, uint8_t state );
 
uint8_t ltecat12_get_cts_pin ( ltecat12_t *ctx );
 
void ltecat12_send_cmd ( ltecat12_t *ctx, uint8_t *cmd );
 
void ltecat12_send_cmd_with_params ( ltecat12_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
 
void ltecat12_send_cmd_check ( ltecat12_t *ctx, uint8_t *at_cmd_buf );
 
void ltecat12_send_cmd_parameter_check ( ltecat12_t *ctx, uint8_t *at_cmd_buf );
 
void ltecat12_set_sim_apn ( ltecat12_t *ctx, uint8_t *sim_apn );
 
void ltecat12_send_sms_text ( ltecat12_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
 
err_t ltecat12_send_sms_pdu ( ltecat12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
 
#ifdef __cplusplus
}
#endif
#endif // LTECAT12_H
 
 // ltecat12
 
// ------------------------------------------------------------------------ END