otas.h File Reference

Over The Air Service API. More...

#include "gr_includes.h"
#include "custom_config.h"
#include "flash_scatter_config.h"

Go to the source code of this file.

Classes

struct  otas_evt_t
 OTA Service event. More...
 
struct  otas_init_t
 OTA Service initialization variable. More...
 

Macros

#define OTAS_CONNECTION_MAX   10
 
#define OTAS_MAX_DATA_LEN   244
 
#define OTAS_VERSION   0x02
 
#define BLE_UUID_OTA_SERVICE
 

Typedefs

typedef void(* otas_evt_handler_t) (otas_evt_t *p_evt)
 OTA Service event handler type. More...
 

Enumerations

enum  otas_dfu_mode_t {
  OTAS_DFU_MODE_RESERVED,
  OTAS_DFU_MODE_COPY_UPGRADE,
  OTAS_DFU_MODE_NON_COPY_UPGRADE
}
 OTA Service dfu mode. More...
 
enum  otas_ctrl_pt_op_code_t {
  OTAS_CTRL_PT_OP_RESERVED,
  OTAS_CTRL_PT_OP_DFU_ENTER = 0x474f4f44,
  OTAS_CTRL_PT_OP_RSP_CODE = 0x10
}
 OTA Service Control Point Operation Code. More...
 
enum  otas_evt_type_t {
  OTAS_EVT_INVALID,
  OTAS_EVT_TX_NOTIFICATION_ENABLED,
  OTAS_EVT_TX_NOTIFICATION_DISABLED,
  OTAS_EVT_CTRL_PT_INDICATION_ENABLED,
  OTAS_EVT_CTRL_PT_INDICATION_DISABLED,
  OTAS_EVT_RX_RECEIVE_DATA,
  OTAS_EVT_NOTIFY_COMPLETE,
  OTAS_EVT_DFU_TASK_ENTER,
  OTAS_EVT_DFU_MODE_SET
}
 OTA Service event type. More...
 

Functions

sdk_err_t otas_service_init (otas_init_t *p_otas_init)
 Add an OTA Service instance in the DB. More...
 
sdk_err_t otas_notify_tx_data (uint8_t conn_idx, uint8_t *p_data, uint16_t length)
 Send data to peer device. More...
 
uint16_t otas_service_start_handle_get (void)
 Provide the interface for other modules to obtain the ots service start handle . More...
 

Detailed Description

Over The Air Service API.

Attention
#####Copyright (c) 2019 GOODIX All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file otas.h.