dfu_api.h File Reference

DFU API declarations.

Copyright (c) 2018 Microchip Technology Inc. and its subsidiaries.

#include "bm_program_mode.h"
#include "ble_api.h"

Macros
#define	DFU_MAX_DATA_LENGTH   192

Enumerations
enum	dfu_status_t {   DFU_SUCCESS = 0x00,   DFU_FAIL }
enum	dfu_write_continue_mode_t {   DFU_WRITE_CONTINUE_START,   DFU_WRITE_CONTINUE_PROCEED,   DFU_WRITE_CONTINUE_STOP }

Functions
dfu_status_t	dfu_deinit (platform_init_t *platform_init)
dfu_status_t	dfu_init (platform_init_t *platform_init)
dfu_status_t	dfu_program_memory_erase (uint32_t address, uint8_t length)
dfu_status_t	dfu_program_memory_read (uint32_t address, uint8_t *data, uint8_t length)
dfu_status_t	dfu_program_memory_write (uint32_t address, uint8_t *data, uint8_t length, bool write_continue)
dfu_status_t	dfu_program_memory_write_continue (uint32_t address, uint8_t *data, uint8_t length, uint8_t continue_mode, uint32_t continue_length)
bool	dfu_response_check (uint8_t byte)

#define DFU_MAX_DATA_LENGTH   192

enum dfu_status_t

Enumerator
DFU_SUCCESS
DFU_FAIL

enum dfu_write_continue_mode_t

Enumerator
DFU_WRITE_CONTINUE_START
DFU_WRITE_CONTINUE_PROCEED
DFU_WRITE_CONTINUE_STOP

dfu_status_t dfu_deinit

(

platform_init_t *

platform_init

)

References BM_MODE_APPLICATION, BM_PROGRAM_Disconnect(), DFU_SUCCESS, EVENT_PKT_TYPE, interface_cmd_send_wait(), ble_platform_api_list_t::mode_set, and platform_init_t::platform_api_list.

dfu_status_t dfu_init

(

platform_init_t *

platform_init

)

References BM_MODE_PROGRAM, BM_PROGRAM_Connect(), BM_PROGRAM_HCI_SUCCESS, BM_PROGRAM_Init(), dfu_status_handle_parser(), dfu_status_report_parser(), DFU_SUCCESS, EVENT_PKT_TYPE, interface_cmd_send_wait(), interface_event_wait(), interface_init(), ble_platform_api_list_t::mode_set, platform_init_t::platform_api_list, and program_handle.

dfu_status_t dfu_program_memory_erase	(	uint32_t	address,
		uint8_t	length
	)

References BM_PROGRAM_Erase(), BM_PROGRAM_HCI_HANDLE, BM_PROGRAM_HCI_SUCCESS, DATA_ACL_PKT_TYPE, dfu_response_report_parser(), dfu_status_report_parser(), DFU_SUCCESS, EVENT_PKT_TYPE, interface_cmd_send_wait(), interface_event_wait(), length, NULL, and program_handle.

dfu_status_t dfu_program_memory_read	(	uint32_t	address,
		uint8_t *	data,
		uint8_t	length
	)

References BM_PROGRAM_HCI_HANDLE, BM_PROGRAM_HCI_SUCCESS, BM_PROGRAM_Read(), data, DATA_ACL_PKT_TYPE, dfu_response_read_parser(), dfu_response_report_parser(), dfu_status_report_parser(), DFU_SUCCESS, EVENT_PKT_TYPE, interface_cmd_send_wait(), interface_event_wait(), length, NULL, and program_handle.

dfu_status_t dfu_program_memory_write	(	uint32_t	address,
		uint8_t *	data,
		uint8_t	length,
		bool	write_continue
	)

References BM_PROGRAM_HCI_SUCCESS, BM_PROGRAM_Write(), data, DATA_ACL_PKT_TYPE, dfu_response_report_parser(), dfu_status_report_parser(), DFU_SUCCESS, EVENT_PKT_TYPE, interface_cmd_send_wait(), interface_event_wait(), length, and program_handle.

dfu_status_t dfu_program_memory_write_continue	(	uint32_t	address,
		uint8_t *	data,
		uint8_t	length,
		uint8_t	continue_mode,
		uint32_t	continue_length
	)

References BM_PROGRAM_HCI_HANDLE, BM_PROGRAM_HCI_SUCCESS, BM_PROGRAM_Write(), BM_PROGRAM_Write_Continue(), data, DATA_ACL_PKT_TYPE, dfu_response_report_parser(), dfu_status_report_parser(), DFU_SUCCESS, DFU_WRITE_CONTINUE_PROCEED, DFU_WRITE_CONTINUE_START, DFU_WRITE_CONTINUE_STOP, EVENT_PKT_TYPE, interface_cmd_send_wait(), interface_event_wait(), length, and program_handle.

bool dfu_response_check

(

uint8_t

byte

)

References BM_PROGRAM_ResponseCheck().

Referenced by interface_process_fifo_data().