otau_debug.h File Reference

OTAU Debug interface.

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

#include "otau.h"
#include "sysTimer.h"

Data Structures
struct	log_request_t
struct	read_mem_indication_t
struct	read_memory_req_t
struct	trace_request_t
struct	write_mem_indication_t
struct	write_memory_req_t

Macros
#define	LOG_INTERVAL_MS   (3000)
#define	LOG_MASK   (0x0F)
#define	TRACE_INTERVAL_MS   (200)

Enumerations
enum	otau_debug_msg_code_t {   OTA_READ_MEMORY_REQUEST = 0,   OTA_READ_MEMORY_INDICATION,   OTA_WRITE_MEMORY_REQUEST,   OTA_WRITE_MEMORY_INDICATION,   OTA_LOG_REQUEST,   OTA_LOG_INDICATION,   OTA_TRACE_REQUEST,   OTA_TRACE_INDICATION }

Functions
void	otauDebugInit (void)
void	otauDebugRcvdFrame (addr_mode_t addr_mode, uint8_t *src_addr, uint16_t length, uint8_t *payload)
void	otauDebugSentFrame (uint8_t messageId, addr_mode_t addr_mode, uint8_t *addr, uint8_t status)
void	otauDebugTimerHandler (SYS_Timer_t *timer)
void	otauHandleDebugMsg (otau_domain_msg_t *otau_domain_msg)

#define LOG_INTERVAL_MS   (3000)

Referenced by otauDebugRcvdFrame(), and otauDebugTimerHandler().

#define LOG_MASK   (0x0F)

Referenced by otauDebugRcvdFrame().

#define TRACE_INTERVAL_MS   (200)

Referenced by otauDebugRcvdFrame().

enum otau_debug_msg_code_t

Enumerator
OTA_READ_MEMORY_REQUEST
OTA_READ_MEMORY_INDICATION
OTA_WRITE_MEMORY_REQUEST
OTA_WRITE_MEMORY_INDICATION
OTA_LOG_REQUEST
OTA_LOG_INDICATION
OTA_TRACE_REQUEST
OTA_TRACE_INDICATION

void otauDebugInit

(

void

)

References BUF_SIZE, curr_debug_timer_state, DEBUG_TIMER_IDLE, initCircularBuffer(), logBufferMem, and traceBufferMem.

Referenced by otauInit().

void otauDebugRcvdFrame	(	addr_mode_t	addr_mode,
		uint8_t *	src_addr,
		uint16_t	length,
		uint8_t *	payload
	)

References BUF_SIZE, curr_debug_timer_state, curr_trace_mode, debug_confirm_wait, DEBUG_LOG_STATE, DEBUG_TRACE_STATE, debugTraceEnable, DOMAIN_OTAU_DEBUG, read_mem_indication_t::domainId, write_mem_indication_t::domainId, EXTENDED_ADDR_MODE, initCircularBuffer(), log_bitmap, LOG_INTERVAL_MS, LOG_MASK, logBufferMem, read_memory_req_t::mem_addr, read_mem_indication_t::mem_addr, write_memory_req_t::mem_addr, write_mem_indication_t::mem_addr, read_mem_indication_t::mem_content, write_memory_req_t::mem_content, read_memory_req_t::mem_len, read_mem_indication_t::mem_len, write_memory_req_t::mem_len, write_mem_indication_t::mem_len, read_memory_req_t::mem_type, read_mem_indication_t::mem_type, write_memory_req_t::mem_type, write_mem_indication_t::mem_type, read_mem_indication_t::msg_id, write_mem_indication_t::msg_id, OTA_LOG_REQUEST, OTA_READ_MEMORY_INDICATION, OTA_READ_MEMORY_REQUEST, OTA_TRACE_REQUEST, OTA_WRITE_MEMORY_INDICATION, OTA_WRITE_MEMORY_REQUEST, OTAU_SUCCESS, otauDataSend(), otauTimerStart(), req_log_addr_mode, read_mem_indication_t::status, write_mem_indication_t::status, TIMER_MODE_PERIODIC, and TRACE_INTERVAL_MS.

Referenced by otauRcvdFrame().

void otauDebugSentFrame	(	uint8_t	messageId,
		addr_mode_t	addr_mode,
		uint8_t *	addr,
		uint8_t	status
	)

References debug_confirm_wait.

Referenced by otauDataConf(), and otauDataSend().

void otauDebugTimerHandler

(

SYS_Timer_t *

timer

)

References APP_MAX_PAYLOAD_SIZE, curr_debug_timer_state, curr_trace_mode, debug_confirm_wait, DEBUG_LOG_STATE, DEBUG_TRACE_STATE, debugTraceEnable, DOMAIN_OTAU_DEBUG, log_indication_t::domainId, trace_indication_t::domainId, EXTENDED_ADDR_MODE, log_bitmap, log_indication_t::log_content, LOG_INTERVAL_MS, log_indication_t::msg_id, trace_indication_t::msg_id, NATIVE_ADDR_MODE, NULL, OTA_LOG_INDICATION, OTA_TRACE_INDICATION, otauDataSend(), otauTimerStart(), otauTimerStop(), PHY_MAX_PAYLOAD_SIZE, readCircularBuffer(), req_log_addr_mode, TIMER_MODE_PERIODIC, trace_indication_t::trace_content, and trace_indication_t::trace_end.

Referenced by otauTimerStart().

void otauHandleDebugMsg

(

otau_domain_msg_t *

otau_domain_msg

)

Referenced by otauHandleMsg().