XDK API  3.6.0
Documentation
Modules | Files | Macros | Enumerations | Functions
ServalPal

Interface header for the ServalPAL. More...

+ Collaboration diagram for ServalPal:

Modules

 NetIF
 Interface header for network interfaces.
 
 PalFilesystem
 Interface header for pal file system interfaces.
 
 RoutingTable
 Interface header for Routing Table.
 
 ServalPalBLE
 PAL adaptation for application to talk LWM2M over Bluetooth peripheral.
 
 ServalPalCellular
 Interface file for Serval PAL Cellular module.
 
 ServalPalLora
 Interface file for Serval PAL Lora module.
 
 ServalPalWiFI
 Interface file for Serval PAL Wifi module.
 

Files

file  BCDS_ServalPal.h
 

Macros

#define BCDS_SERVALPAL_BLE   0
 
#define BCDS_SERVALPAL_CELLULAR   0
 
#define BCDS_SERVALPAL_LORA   0
 
#define BCDS_SERVALPAL_MULTINETIF_BLE   0
 
#define BCDS_SERVALPAL_MULTINETIF_CELLULAR   0
 
#define BCDS_SERVALPAL_MULTINETIF_LORA   0
 
#define BCDS_SERVALPAL_MULTINETIF_SUPPORT   0
 
#define BCDS_SERVALPAL_MULTINETIF_WIFI   0
 
#define BCDS_TCP_PORT   UINT16_C(49152)
 
#define BCDS_UDP_PORT   UINT16_C(5684)
 

Enumerations

enum  BCDS_SERVALPAL_ModuleID_E
 BCDS_MODULE_ID for each ServaPAL C module usage: #undef BCDS_MODULE_ID #define BCDS_MODULE_ID BCDS_SERVALPAL_MODULE_ID_xxx. More...
 
enum  ServalPal_Retcode_E
 

Functions

Retcode_T ServalPal_Initialize (CmdProcessor_T *schedulerProcessor_ptr)
 This function initializes the virtual ServalPal including the communication buffer and scheduler. More...
 

Detailed Description

Macro Definition Documentation

#define BCDS_SERVALPAL_BLE   0
#define BCDS_SERVALPAL_CELLULAR   0
#define BCDS_SERVALPAL_LORA   0
#define BCDS_SERVALPAL_MULTINETIF_BLE   0
#define BCDS_SERVALPAL_MULTINETIF_CELLULAR   0
#define BCDS_SERVALPAL_MULTINETIF_LORA   0
#define BCDS_SERVALPAL_MULTINETIF_SUPPORT   0
#define BCDS_SERVALPAL_MULTINETIF_WIFI   0
#define BCDS_TCP_PORT   UINT16_C(49152)
#define BCDS_UDP_PORT   UINT16_C(5684)

Enumeration Type Documentation

Enumerator
BCDS_SERVALPAL_MODULE_ID_PALLOGGER 
BCDS_SERVALPAL_MODULE_ID_PALBASICS 
BCDS_SERVALPAL_MODULE_ID_PALCLOCK 
BCDS_SERVALPAL_MODULE_ID_PALCOMMBUFF 
BCDS_SERVALPAL_MODULE_ID_PALIP 
BCDS_SERVALPAL_MODULE_ID_PALMCASTMGMT 
BCDS_SERVALPAL_MODULE_ID_PALSCHEDULER 
BCDS_SERVALPAL_MODULE_ID_PALTIMER 
BCDS_SERVALPAL_MODULE_ID_PALUDPCOMMON 
BCDS_SERVALPAL_MODULE_ID_SERVALPALCOMMON 
BCDS_SERVALPAL_MODULE_ID_SERVALPALCOMMONSOCKET 
BCDS_SERVALPAL_MODULE_ID_SERVALPALBLE 
BCDS_SERVALPAL_MODULE_ID_SERVALPALCELLULAR 
BCDS_SERVALPAL_MODULE_ID_NETIF 
BCDS_SERVALPAL_MODULE_ID_ROUTINGTABLE 
BCDS_SERVALPAL_MODULE_ID_CYCURTLS_DTLS 
BCDS_SERVALPAL_MODULE_ID_CYCURTLS_DTLSCLIENT 
BCDS_SERVALPAL_MODULE_ID_CYCURTLS_DTLSSERVER 
BCDS_SERVALPAL_MODULE_ID_CYCURTLS_TLS 
BCDS_SERVALPAL_MODULE_ID_CYCURTLSADAPTER 
BCDS_SERVALPAL_MODULE_ID_CYCURTLSCONNECTION 
BCDS_SERVALPAL_MODULE_ID_CYCURTLSSOCKET 
BCDS_SERVALPAL_MODULE_ID_SERVALPALLORA 
BCDS_SERVALPAL_MODULE_ID_SERVALPALCELLULARADAPTER 
BCDS_SERVALPAL_MODULE_ID_SERVALPALBLEADAPTER 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFI 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFIADAPTER 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFIADAPTERSOCKET 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFITCP 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFITCPADAPTER 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFIUDP 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFIUDPADAPTER 
BCDS_SERVALPAL_MODULE_ID_SERVALPALWIFISOCKET 
BCDS_SERVALPAL_MODULE_ID_SERVALPALLORAADAPTER 
BCDS_SERVALPAL_MODULE_ID_PALFILESYSTEM 
Enumerator
RETCODE_BLE_PACKET_SEND_FAILED 

a consecutive BLE packet send failed

CELLULAR_DATA_RECEIVED_IN_INVALID_SOC 

an incoming message has arrived in an invalid socket

BLE_SEND_TRIGGERED_ON_NO_CONNECTION 

a send operation is triggered via BLE channel when there is no physical connection

BLE_SEND_CALLBACK_WAS_NOT_RECEIVED 

the BLE send callback was not received in time

RETCODE_SCHEDULER_ENQUEUE_FAILED 

Scheduler_enqueue API returned failure

RETCODE_SOCKET_CLOSE_FAILED 

Socket close failed while freeing the resources

RETCODE_CALLABLE_NOT_VALID_UPON_SCHEDULING 

While dequeuing the scheduler found the callable to be invalid

RETCODE_FATAL_ERROR_IN_STACK 

Stack reported a fatal error

RETCODE_SOC_INVALID_ON_DATA_RECV 

socket was invalid while trying to read an incoming message notification

RETCODE_DATA_RECV_CB_RETURNED_FAILURE 

socket receive callback return failure in socket close procedure

RETCODE_DISCARDED_RETRY 

a retryForSendingLater procedure discarded a request since it was already loaded

RETCODE_SERVAL_PAL_MAX 

Defines boundary of ServalPAL custom error codes

Function Documentation

Retcode_T ServalPal_Initialize ( CmdProcessor_T schedulerProcessor_ptr)
Parameters
[in]schedulerProcessor_ptr- Command processor handle
Returns
RETCODE_OK in case of successful queue creation or some error code otherwise
RETCODE_INVALID_PARAM schedulerProcessor_ptr has been passed as NULL
RETCODE_OUT_OF_RESOURCES Creating Mutex failure

+ Here is the caller graph for this function:


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