XDK API  3.6.0
Documentation
Modules | Files | Enumerations
Utils

Utility module. More...

+ Collaboration diagram for Utils:

Modules

 CRC
 routines for CRC8, CRC16 and CRC32
 
 CmdLineDebugger
 Command Line Debug Interface Header.
 
 CmdProcessor
 Handles the execution of enqueued commands.
 
 ErrorLogger
 This file contains public interface for ErrorLogger module.
 
 EventHub
 A framework for distributing events in a system.
 
 GuardedTask
 Guarded Task interface.
 
 I2CTransceiver
 Advanced API functions for sending and receiving via I2C.
 
 LeanB2CAP
 LeanB2CAP API for CoSP.
 
 Logging
 Defines the user API for logging.
 
 Queue
 Defines the interface for message queue (FIFO data structure) with variable size of elements.
 
 Ring Buffer
 Ring Buffer Interface.
 
 Sleep Control
 Sleep Control.
 
 TLV
 TLV data handler.
 
 TaskMonitor
 Monitor the system tasks in order to detect deadlocks or significant mismatch with the expected scheduling.
 
 UARTTransceiver
 Advanced API functions for sending and reveiving via UART and LEUART.
 
 XProtocol
 API to encode and decode xProtocol frames.
 

Files

file  BCDS_Utils.h
 

Enumerations

enum  BCDS_UTILS_ModuleID_E
 BCDS_MODULE_ID for each Utils C module. More...
 
enum  Utils_Retcode_E
 Enumeration to represent the return codes of Utils module. More...
 

Detailed Description

Enumeration Type Documentation

Usage:

#undef BCDS_MODULE_ID
#define BCDS_MODULE_ID BCDS_UTILS_MODULE_ID_xxx
Enumerator
BCDS_UTILS_MODULE_ID_CRC 
BCDS_UTILS_MODULE_ID_LEANB2CAP 
BCDS_UTILS_MODULE_ID_RINGBUFFER 
BCDS_UTILS_MODULE_ID_TLV 
BCDS_UTILS_MODULE_ID_XPROTOCOL 
BCDS_UTILS_MODULE_ID_LOGGING 
BCDS_UTILS_MODULE_ID_LOGGING_FILTER 
BCDS_UTILS_MODULE_ID_LOGGING_RECORD_ASYNCHRONOUS 
BCDS_UTILS_MODULE_ID_LOGGING_APPENDER_UART 
BCDS_UTILS_MODULE_ID_LOGGING_APPENDER_SWO 
BCDS_UTILS_MODULE_ID_CMD_LINE_DEBUGGER 
BCDS_UTILS_MODULE_ID_UART_TRANSCEIVER 
BCDS_UTILS_MODULE_ID_I2C_TRANSCEIVER 
BCDS_UTILS_MODULE_ID_ERRORLOGGER 
BCDS_UTILS_MODULE_ID_CMDPROCESSOR 
BCDS_UTILS_MODULE_ID_GUARDEDTASK 
BCDS_UTILS_MODULE_ID_TASKMONITOR 
BCDS_UTILS_MODULE_ID_QUEUE 
BCDS_UTILS_MODULE_ID_EVENTHUB 
BCDS_UTILS_MODULE_ID_SLEEPCONTROL 
Enumerator
RETCODE_LEANB2CAP_SD_ERROR 
RETCODE_LEANB2CAP_LENGTH_ERROR 
RETCODE_LEANB2CAP_CMD_TYPE_ERROR 
RETCODE_LEANB2CAP_FRAME_ERROR 
RETCODE_LEANB2CAP_CRC_ERROR 
RETCODE_LEANB2CAP_RX_PROCESSOR_ERROR 
RETCODE_LEANB2CAP_RX_PROCESSOR_FAIL 
RETCODE_LEANB2CAP_OP_BUFFER_OVERFLOW 
RETCODE_LEANB2CAP_OP_BUFFER_INSUFFICIENT 
RETCODE_LEANB2CAP_INVALID_CALLBACK 
RETCODE_XPROTOCOL_INTEGRITY_FAILED 
RETCODE_XPROTOCOL_FRAME_BUFFER_TOO_SMALL 
RETCODE_XPROTOCOL_DATA_BUFFER_TOO_SMALL 
RETCODE_XPROTOCOL_DATA_EXCEEDES_MAX_PAYLOAD_LENGTH 
RETCODE_XPROTOCOL_FRAME_NOT_COMPLETE_YET 
RETCODE_XPROTOCOL_START_DELIMITER_MISSING 
RETCODE_XPROTOCOL_END_DELIMITER_MISSING 
RETCODE_CMDLINE_DEBUGGER_COMMAND_NOT_FOUND 
RETCODE_CMDPROCESSOR_TASK_INIT_FAIL 

Failed to initialize Command Processor Task

RETCODE_CMDPROCESSOR_QUEUE_INIT_FAIL 

Failed to initialize CmdProcessor Queue

RETCODE_CMDPROCESSOR_QUEUE_ENQUEUE_FAIL 

Failed to enqueue element, probably because of a timeout

RETCODE_CMDPROCESSOR_QUEUE_DEQUEUE_FAIL 

Failed to dequeue element, probably because of a timeout

RETCODE_CMDPROCESSOR_EXECUTE_FAILURE 

Command to be executed was a NULL pointer

RETCODE_CMDPROCESSOR_QUEUE_ERROR 
RETCODE_GUARDEDTASK_SEMAPHORE_ALREADY_GIVEN 
RETCODE_GUARDEDTASK_SEMAPHORE_ERROR 
RETCODE_TASKMONITOR_BUFFER_FULL_ERROR 
RETCODE_SLEEPCONTROL_NOSLEEP 
RETCODE_I2CTRANSCEIVER_TRANSFER_ERROR 
RETCODE_MAX_ERROR 

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:52 by doxygen 1.8.8