Cordio Stack and Cordio Profiles  r2p3-02rel0
Wireless Data Exchange Profile

Data Structures

struct  wdxcConnCb_t
 WDXC Connection Control Block. More...
 
struct  wdxcCb_t
 WDXC Control Block. More...
 
struct  wdxsCb_t
 WDXS profile control block. More...
 
struct  wdxsDcCb_t
 WDXS Device Configuration Control Block. More...
 
struct  wdxsAuCb_t
 WDXS Authentication Control Block. More...
 
union  wdxsMsg_t
 WDXS event message union. More...
 

Macros

#define WDX_UUID_PART1
 Base UUID: 005fXXXX-2ff2-4ed5-b045-4C7463617865. More...
 
#define WDX_UUID_PART2   0x5f, 0x00
 Base UUID Part 2.
 
#define WDX_UUID_BUILD(part)    WDX_UUID_PART1, UINT16_TO_BYTES(part), WDX_UUID_PART2
 Macro for building UUIDs.
 
#define WDX_SVC_UUID   0xFEF6
 WDX Service.
 
#define WDX_DC_UUID   WDX_UUID_BUILD(0x0002)
 WDX Device Configuration Characteristic.
 
#define WDX_FTC_UUID   WDX_UUID_BUILD(0x0003)
 WDX File Transfer Control Characteristic.
 
#define WDX_FTD_UUID   WDX_UUID_BUILD(0x0004)
 WDX File Transfer Data Characteristic.
 
#define WDX_AU_UUID   WDX_UUID_BUILD(0x0005)
 WDX Authentication Characteristic.
 
#define WDX_DC_HDR_LEN   2
 Device configuration characteristic message header length.
 
#define WDX_FTD_HDR_LEN   0
 File transfer data characteristic message header length.
 
#define WDX_AU_HDR_LEN   1
 Authentication message header length.
 
#define WDXS_APP_RAM_MEDIA_SIZE   256
 Size of RAM Media used by the application.
 
#define WDXS_DEVICE_MODEL   "WDXS App"
 Device Model Name.
 
#define WDXS_STREAM_FILE_LEN   0xFFFFFFFF
 Special length for streaming file.
 

Typedefs

typedef void WdxcFtdCallback_t(dmConnId_t connId, uint16_t handle, uint16_t len, uint8_t *pData)
 WDXC File Transfer Data callback. More...
 
typedef void WdxcFtcCallback_t(dmConnId_t connId, uint16_t handle, uint8_t op, uint8_t status)
 WDXC File Transfer Control callback. More...
 
typedef uint8_t(* wdxsDcPhyWriteCback_t) (dmConnId_t connId, uint8_t op, uint8_t id, uint16_t len, uint8_t *pValue)
 WDXS Device Configuration PHY Write Callback.
 

Enumerations

enum  {
  WDXC_DC_HDL_IDX,
  WDXC_DC_CCC_HDL_IDX,
  WDXC_FTC_HDL_IDX,
  WDXC_FTC_CCC_HDL_IDX,
  WDXC_FTD_HDL_IDX,
  WDXC_FTD_CCC_HDL_IDX,
  WDXC_AU_HDL_IDX,
  WDXC_AU_CCC_HDL_IDX,
  WDXC_HDL_LIST_LEN
}
 WDXC enumeration of handle indexes of characteristics to be discovered. More...
 

Functions

void WdxcInit (WdxcFtdCallback_t *pFtdCallback, WdxcFtcCallback_t *pFtcCallback)
 Initialize the WDXC. More...
 
void WdxcProcMsg (wsfMsgHdr_t *pEvt)
 Called by application to notify the WDXC of DM and ATT Events. More...
 
void WdxcWdxsDiscover (dmConnId_t connId, uint16_t *pHdlList)
 Perform service and characteristic discovery for Wireless Data Exchange service. Parameter pHdlList must point to an array of length WDXC_HDL_LIST_LEN. If discovery is successful the handles of discovered characteristics and descriptors will be set in pHdlList. More...
 
void WdxcDiscoverFiles (dmConnId_t connId, wsfEfsFileInfo_t *pFileInfo, uint8_t maxFiles)
 Perform File Discovery. More...
 
void WdxcStreamStart (dmConnId_t connId, uint16_t fileHdl)
 Send a request to start a stream of a given file handle on the given connection. More...
 
void WdxcStreamStop (dmConnId_t connId)
 Stop the active stream. More...
 
void WdxcFtcSendAbort (dmConnId_t connId, uint16_t fileHdl)
 Send a request to abort a wdx operation. More...
 
void WdxcFtcSendEraseFile (dmConnId_t connId, uint16_t fileHdl)
 Send a request to erase a file. More...
 
void WdxcFtcSendVerifyFile (dmConnId_t connId, uint16_t fileHdl)
 Send a request to verify a file. More...
 
void WdxcFtcSendPutReq (dmConnId_t connId, uint16_t fileHdl, uint32_t offset, uint32_t len, uint32_t fileSize, uint8_t type)
 Send a request to put a block of data into a file on the peer device. More...
 
void WdxcFtcSendGetReq (dmConnId_t connId, uint16_t fileHdl, uint32_t offset, uint32_t len, uint8_t type)
 Send a request to perform a get a block of data from a file on the peer device. More...
 
void WdxcFtdSendBlock (dmConnId_t connId, uint32_t len, uint8_t *pData)
 Send a data block to the peer device. More...
 
void WdxsAuthenticationCfg (bool_t reqLevel, uint8_t *pKey)
 Called at startup to configure WDXS authentication. More...
 
void WdxsHandler (wsfEventMask_t event, wsfMsgHdr_t *pMsg)
 Handle WSF events for WDXS. More...
 
void WdxsHandlerInit (wsfHandlerId_t handlerId)
 WSF Task Initialization for WDXS task. More...
 
uint8_t WdxsAttCback (attEvt_t *pEvt)
 Called by application to notify the WDXS of ATT Events. More...
 
void WdxsProcDmMsg (dmEvt_t *pEvt)
 Called by application to notify the WDXS of DM Events. More...
 
void WdxsSetCccIdx (uint8_t dcCccIdx, uint8_t auCccIdx, uint8_t ftcCccIdx, uint8_t ftdCccIdx)
 Set the CCCD index used by the application for WDXS service characteristics. More...
 
void WdxsFlashMediaInit (void)
 Registers the platform dependent Flash Media with the Embedded File System (EFS) More...
 
void WdxsOtaMediaInit (void)
 Registers the platform dependent OTA Media with the Embedded File System (EFS) More...
 
void WdxsResetSystem (void)
 Resets the system. More...
 
void WdxsPhyInit (void)
 Initialize WDXS Device Configuration PHY. More...
 
void wdxsDcSend (dmConnId_t connId)
 Send device configuration notification. More...
 
void wdxsFtcSend (dmConnId_t connId)
 Send a file transfer control characteristic notification. More...
 
void wdxsFtdSend (dmConnId_t connId)
 Send a file transfer data characteristic notification. More...
 
void wdxsAuSend (dmConnId_t connId)
 Transmit to authentication characteristic. More...
 
uint8_t wdxsDcWrite (dmConnId_t connId, uint16_t len, uint8_t *pValue)
 Process a write to the device configuration characteristic. More...
 
uint8_t wdxsFtcWrite (dmConnId_t connId, uint16_t len, uint8_t *pValue)
 Process a write to the file transfer control characteristic. More...
 
uint8_t wdxsFtdWrite (dmConnId_t connId, uint16_t len, uint8_t *pValue)
 Process a write to the file transfer data characteristic. More...
 
uint8_t wdxsAuWrite (dmConnId_t connId, uint16_t len, uint8_t *pValue)
 Process a write to the authentication characteristic. More...
 
uint8_t wdxsDcUpdateConnParam (dmConnId_t connId, uint8_t status)
 Send update message for connection parameters. More...
 
uint8_t wdxsDcUpdatePhy (dmConnId_t connId, uint8_t status)
 Send update message for PHY. More...
 
void wdxsDcPhyRegister (wdxsDcPhyWriteCback_t cback)
 Register a PHY write callback for the device configuration characteristic. More...
 
void WdxsUpdateListing (void)
 Create the file list. More...
 
void wdxsStreamInit (void)
 Example of creating a WDXS stream. More...
 
void wdxsSetStreamWaveform (uint8_t type)
 Changes the type of waveform transmitted by the stream. More...
 

WDXS File List Configuration

#define WDX_FLIST_HANDLE   0
 File List handle.
 
#define WDX_FLIST_FORMAT_VER   1
 File List version.
 
#define WDX_FLIST_HDR_SIZE   7
 File List header length.
 
#define WDX_FLIST_RECORD_SIZE   40
 File List record length.
 
#define WDX_FLIST_MAX_LEN   (WDX_FLIST_HDR_SIZE + (WDX_FLIST_RECORD_SIZE * (WSF_EFS_MAX_FILES-1)))
 File list max length.
 

Device Configuration Characteristic oOperations

#define WDX_DC_OP_GET   0x01
 Get a parameter value.
 
#define WDX_DC_OP_SET   0x02
 Set a parameter value.
 
#define WDX_DC_OP_UPDATE   0x03
 Send an update of a parameter value.
 

Device Control Characteristic Parameter IDs

#define WDX_DC_ID_CONN_UPDATE_REQ   0x01
 Connection Parameter Update Request.
 
#define WDX_DC_ID_CONN_PARAM   0x02
 Current Connection Parameters.
 
#define WDX_DC_ID_DISCONNECT_REQ   0x03
 Disconnect Request.
 
#define WDX_DC_ID_CONN_SEC_LEVEL   0x04
 Connection Security Level.
 
#define WDX_DC_ID_SECURITY_REQ   0x05
 Security Request.
 
#define WDX_DC_ID_SERVICE_CHANGED   0x06
 Service Changed.
 
#define WDX_DC_ID_DELETE_BONDS   0x07
 Delete Bonds.
 
#define WDX_DC_ID_ATT_MTU   0x08
 Current ATT MTU.
 
#define WDX_DC_ID_PHY_UPDATE_REQ   0x09
 PHY update request.
 
#define WDX_DC_ID_PHY   0x0A
 Current PHY.
 
#define WDX_DC_ID_BATTERY_LEVEL   0x20
 Battery level.
 
#define WDX_DC_ID_MODEL_NUMBER   0x21
 Device Model.
 
#define WDX_DC_ID_FIRMWARE_REV   0x22
 Device Firmware Revision.
 
#define WDX_DC_ID_ENTER_DIAGNOSTICS   0x23
 Enter Diagnostic Mode.
 
#define WDX_DC_ID_DIAGNOSTICS_COMPLETE   0x24
 Diagnostic Complete.
 
#define WDX_DC_ID_DISCONNECT_AND_RESET   0x25
 Disconnect and Reset.
 

Device Control Parameter Lengths

#define WDX_DC_LEN_DATA_FORMAT   1
 Data format.
 
#define WDX_DC_LEN_SEC_LEVEL   1
 Security Level.
 
#define WDX_DC_LEN_ATT_MTU   2
 ATT MTU.
 
#define WDX_DC_LEN_BATTERY_LEVEL   1
 Battery level.
 
#define WDX_DC_LEN_CONN_PARAM_REQ   8
 Connection parameter request.
 
#define WDX_DC_LEN_CONN_PARAM   7
 Current connection parameters.
 
#define WDX_DC_LEN_PHY_UPDATE_REQ   5
 PHY update request.
 
#define WDX_DC_LEN_PHY   3
 Current PHY.
 
#define WDX_DC_LEN_DIAG_COMPLETE   0
 Diagnostic complete.
 
#define WDX_DC_LEN_DEVICE_MODEL   18
 Device Model.
 
#define WDX_DC_LEN_FIRMWARE_REV   16
 Firmware Revision.
 

File Transfer Control Characteristic Message Header Length

#define WDX_FTC_HDR_LEN   1
 Header length.
 
#define WDX_FTC_HANDLE_LEN   2
 Handle length.
 

File Transfer Control Characteristic Operations

#define WDX_FTC_OP_NONE   0x00
 No operation.
 
#define WDX_FTC_OP_GET_REQ   0x01
 Get a file from the server.
 
#define WDX_FTC_OP_GET_RSP   0x02
 File get response.
 
#define WDX_FTC_OP_PUT_REQ   0x03
 Put a file to the server.
 
#define WDX_FTC_OP_PUT_RSP   0x04
 File put response.
 
#define WDX_FTC_OP_ERASE_REQ   0x05
 Erase a file on the server.
 
#define WDX_FTC_OP_ERASE_RSP   0x06
 File erase response.
 
#define WDX_FTC_OP_VERIFY_REQ   0x07
 Verify a file (e.g. check its CRC)
 
#define WDX_FTC_OP_VERIFY_RSP   0x08
 File verify response.
 
#define WDX_FTC_OP_ABORT   0x09
 Abort a get, put, or list operation in progress.
 
#define WDX_FTC_OP_EOF   0x0a
 End of file reached.
 

File Transfer Control Permissions

#define WDX_FTC_GET_PERMITTED   0x01
 File Get Permitted.
 
#define WDX_FTC_PUT_PERMITTED   0x02
 File Put Permitted.
 
#define WDX_FTC_ERASE_PERMITTED   0x04
 File Erase Permitted.
 
#define WDX_FTC_VERIFY_PERMITTED   0x08
 File Verify Permitted.
 

File Transfer Control Characteristic Status

#define WDX_FTC_ST_SUCCESS   0
 Success.
 
#define WDX_FTC_ST_INVALID_OP_FILE   1
 Invalid operation for this file.
 
#define WDX_FTC_ST_INVALID_HANDLE   2
 Invalid file handle.
 
#define WDX_FTC_ST_INVALID_OP_DATA   3
 Invalid operation data.
 
#define WDX_FTC_ST_IN_PROGRESS   4
 Operation in progress.
 
#define WDX_FTC_ST_VERIFICATION   5
 Verification failure.
 

File Transfer Control Transport

#define WDX_FTC_TRANSPORT_TYPE   0
 Transport Type.
 
#define WDX_FTC_TRANSPORT_ID   0x0030
 Transport ID.
 

Authentication Characteristic Operations

#define WDX_AU_OP_START   0x01
 Authentication start.
 
#define WDX_AU_OP_CHALLENGE   0x02
 Authentication challenge.
 
#define WDX_AU_OP_REPLY   0x03
 Authentication reply.
 

Proprietary ATT Error Codes

#define WDX_APP_AUTH_REQUIRED   0x80
 Application authentication required.
 
#define WDX_AU_ST_INVALID_MESSAGE   0x81
 Authentication invalid message.
 
#define WDX_AU_ST_INVALID_STATE   0x82
 Authentication invalid state.
 
#define WDX_AU_ST_AUTH_FAILED   0x83
 Authentication failed.
 

Authentication Characteristic Authentication Level

#define WDX_AU_LVL_NONE   0x00
 None.
 
#define WDX_AU_LVL_USER   0x01
 User level.
 
#define WDX_AU_LVL_MAINT   0x02
 Maintenance level.
 
#define WDX_AU_LVL_DEBUG   0x03
 Debug level.
 

Authenttication Characteristic Message Parameter Lengths

#define WDX_AU_MSG_HDR_LEN   1
 Message header length.
 
#define WDX_AU_PARAM_LEN_START   2
 Authentication start.
 
#define WDX_AU_PARAM_LEN_CHALLENGE   16
 Authentication challenge.
 
#define WDX_AU_PARAM_LEN_REPLY   8
 Authentication reply.
 

Authenttication Characteristic Random Number and Key Lengths

#define WDX_AU_RAND_LEN   16
 Authentication Random challenge length (bytes)
 
#define WDX_AU_KEY_LEN   16
 Authentication Key length (bytes)
 
#define WDX_AU_HASH_LEN   8
 Authentication Hash length (bytes)
 

WDXS Media Types

#define WDX_FLASH_MEDIA   0
 Flash media type.
 
#define WDX_OTA_MEDIA   1
 OTA media type.
 
#define WDX_RAM_MEDIA   2
 RAM media type.
 
#define WDX_STREAM_MEDIA   3
 Stream media type.
 

WDXS File Transfer Control Command Message Lengths

#define WDX_FTC_ABORT_LEN   3
 Abort message length.
 
#define WDX_FTC_ERASE_LEN   3
 Erase message length.
 
#define WDX_FTC_VERIFY_LEN   3
 Verify message length.
 
#define WDX_FTC_PUT_LEN   16
 Put message length.
 
#define WDX_FTC_GET_LEN   12
 Get message length.
 

WDXS Default Feature Set

#define WDXS_DC_ENABLED   TRUE
 
#define WDXS_AU_ENABLED   TRUE
 
#define WDXS_OTA_ENABLED   TRUE
 

WSF event types for application event handler

#define WDXS_EVT_TX_PATH   0x01
 Trigger tx data path.
 
#define WDXS_EVT_AU_SEC_COMPLETE   0x02
 AU encryption of challenge ready.
 

TX Ready Mask Bits

#define WDXS_TX_MASK_READY_BIT   (1<<0)
 Ready bit.
 
#define WDXS_TX_MASK_DC_BIT   (1<<1)
 DC bit.
 
#define WDXS_TX_MASK_FTC_BIT   (1<<2)
 FTC bit.
 
#define WDXS_TX_MASK_FTD_BIT   (1<<3)
 FTD bit.
 
#define WDXS_TX_MASK_AU_BIT   (1<<4)
 AU bit.
 

Authentication states

#define WDXS_AU_STATE_UNAUTHORIZED   0x00
 Authentication has not started.
 
#define WDXS_AU_STATE_HASHING   0x01
 Authentication hash is being calculated.
 
#define WDXS_AU_STATE_WAIT_SEC   0x02
 Authentication challenge sent.
 
#define WDXS_AU_STATE_WAIT_REPLY   0x03
 Authentication waiting for challenge reply.
 
#define WDXS_AU_STATE_AUTHORIZED   0x04
 Authentication completed successfully.
 

WDXS Control Block External Declaration

wdxsCb_t wdxsCb
 WDXS control block.
 
wdxsAuCb_t wdxsAuCb
 WDXS AU control block.
 
wdxsDcCb_t wdxsDcCb
 WDXS DC control block.
 

WDXS Stream Waveform Types

Type of waveform to output from the Example Stream

#define WDXS_STREAM_WAVEFORM_SINE   0
 
#define WDXS_STREAM_WAVEFORM_STEP   1
 
#define WDXS_STREAM_WAVEFORM_SAWTOOTH   2
 

Description

The Wireless Data Exchange Profile is an ARM proprietary profile used to transmit and receive data files and streams of data.

The Wireless Data Exchange Profile has the following subsystems:

The File Transfer subsystem is used to push and pull files to and from an embedded file system (EFS). For more information about EFS used with the Wireless Data Exchange Profile, see WSF Embedded File System API.

The Authentication subsystem is used to ensure an authentic link to a server.

The Device Configuration subsystem is used for the exchange of the following configuration settings with a server:

The Data Streaming subsystem can be used to transfer streams of data used in audio, video, health and fitness, and other applications.

The Wireless Data Exchange Profile is also used for the transfer of OTA Images (Over the Air Firmware Update Images).

Wireless Data Exchange Server (WDXS)

The Wireless Data Exchange Server (WDXS) implements wireless data exchange functionality required for sensor devices.

Note: The WDXS operates in the context of its own task. Therefore, when adding WDXS to an application, it is necessary to register a task handler in the initialization section of the application’s main() function by adding the following lines following the registration of other task handlers:

wsfOs.task.handler[wsfOs.task.numHandler] = WdxsHandler;
WdxsHandlerInit(wsfOs.task.numHandler++);

Macro Definition Documentation

#define WDX_UUID_PART1
Value:
0x65, 0x78, 0x61, 0x63, 0x74, 0x4c, 0x45, 0xb0, \
0xd5, 0x4e, 0xf2, 0x2f

Base UUID: 005fXXXX-2ff2-4ed5-b045-4C7463617865.

Definition at line 36 of file wdx_defs.h.

Typedef Documentation

typedef void WdxcFtdCallback_t(dmConnId_t connId, uint16_t handle, uint16_t len, uint8_t *pData)

WDXC File Transfer Data callback.

Parameters
connIdConnection ID.
handleHandle of the file.
lenlength of pData in bytes.
pDataFile data.
Returns
None.

Definition at line 73 of file wdxc_api.h.

typedef void WdxcFtcCallback_t(dmConnId_t connId, uint16_t handle, uint8_t op, uint8_t status)

WDXC File Transfer Control callback.

Parameters
connIdConnection ID.
handleHandle of the file.
opControl operation.
statusStatus of operation.
Returns
None.

Definition at line 87 of file wdxc_api.h.

Enumeration Type Documentation

anonymous enum

WDXC enumeration of handle indexes of characteristics to be discovered.

Enumerator
WDXC_DC_HDL_IDX 

WDX Device Configuration.

WDXC_DC_CCC_HDL_IDX 

WDX Device Configuration CCC descriptor.

WDXC_FTC_HDL_IDX 

WDX File Transfer Control.

WDXC_FTC_CCC_HDL_IDX 

WDX File Transfer Control CCC descriptor.

WDXC_FTD_HDL_IDX 

WDX File Transfer Data.

WDXC_FTD_CCC_HDL_IDX 

WDX File Transfer Data CCC descriptor.

WDXC_AU_HDL_IDX 

WDX Authenticationa.

WDXC_AU_CCC_HDL_IDX 

WDX Authentication CCC descriptor.

WDXC_HDL_LIST_LEN 

WDX handle list length.

Definition at line 35 of file wdxc_api.h.

36 {
37  WDXC_DC_HDL_IDX, /*!< \brief WDX Device Configuration */
38  WDXC_DC_CCC_HDL_IDX, /*!< \brief WDX Device Configuration CCC descriptor */
39  WDXC_FTC_HDL_IDX, /*!< \brief WDX File Transfer Control */
40  WDXC_FTC_CCC_HDL_IDX, /*!< \brief WDX File Transfer Control CCC descriptor */
41  WDXC_FTD_HDL_IDX, /*!< \brief WDX File Transfer Data */
42  WDXC_FTD_CCC_HDL_IDX, /*!< \brief WDX File Transfer Data CCC descriptor */
43  WDXC_AU_HDL_IDX, /*!< \brief WDX Authenticationa */
44  WDXC_AU_CCC_HDL_IDX, /*!< \brief WDX Authentication CCC descriptor */
45  WDXC_HDL_LIST_LEN /*!< \brief WDX handle list length. */
46 };
WDX Device Configuration.
Definition: wdxc_api.h:37
WDX File Transfer Data CCC descriptor.
Definition: wdxc_api.h:42
WDX Device Configuration CCC descriptor.
Definition: wdxc_api.h:38
WDX Authentication CCC descriptor.
Definition: wdxc_api.h:44
WDX File Transfer Control CCC descriptor.
Definition: wdxc_api.h:40
WDX File Transfer Data.
Definition: wdxc_api.h:41
WDX File Transfer Control.
Definition: wdxc_api.h:39
WDX handle list length.
Definition: wdxc_api.h:45
WDX Authenticationa.
Definition: wdxc_api.h:43

Function Documentation

void WdxcInit ( WdxcFtdCallback_t pFtdCallback,
WdxcFtcCallback_t pFtcCallback 
)

Initialize the WDXC.

Parameters
pFtdCallbackApplication Callback for File Transfer Data.
pFtcCallbackApplication Callback for File Transfer Control.
Returns
None.
void WdxcProcMsg ( wsfMsgHdr_t pEvt)

Called by application to notify the WDXC of DM and ATT Events.

Parameters
pEvtPointer to the Event
Returns
None.
void WdxcWdxsDiscover ( dmConnId_t  connId,
uint16_t pHdlList 
)

Perform service and characteristic discovery for Wireless Data Exchange service. Parameter pHdlList must point to an array of length WDXC_HDL_LIST_LEN. If discovery is successful the handles of discovered characteristics and descriptors will be set in pHdlList.

Parameters
connIdConnection identifier.
pHdlListCharacteristic handle list.
Returns
None.
void WdxcDiscoverFiles ( dmConnId_t  connId,
wsfEfsFileInfo_t pFileInfo,
uint8_t  maxFiles 
)

Perform File Discovery.

Parameters
connIdConnection ID.
pFileInfoBuffer to hold information about files
maxFilesSize of pFileInfo in number of wsfEfsFileInfo_t objects
Note
When file discovery completes, the ftcCallback() will be called with operator equal to WDX_FTC_OP_EOF and file handle equal to WDX_FLIST_HANDLE.
Returns
None.
void WdxcStreamStart ( dmConnId_t  connId,
uint16_t  fileHdl 
)

Send a request to start a stream of a given file handle on the given connection.

Parameters
connIdConnection ID.
fileHdlHandle of the file.
Returns
none.
void WdxcStreamStop ( dmConnId_t  connId)

Stop the active stream.

Parameters
connIdConnection ID.
Returns
None.
void WdxcFtcSendAbort ( dmConnId_t  connId,
uint16_t  fileHdl 
)

Send a request to abort a wdx operation.

Parameters
connIdConnection ID.
fileHdlHandle of file to abort operation on peer device
Returns
None.
void WdxcFtcSendEraseFile ( dmConnId_t  connId,
uint16_t  fileHdl 
)

Send a request to erase a file.

Parameters
connIdConnection ID.
fileHdlHandle of file to erase on peer device
Returns
None.
void WdxcFtcSendVerifyFile ( dmConnId_t  connId,
uint16_t  fileHdl 
)

Send a request to verify a file.

Parameters
connIdConnection ID.
fileHdlHandle of file to verify on peer device
Returns
None.
void WdxcFtcSendPutReq ( dmConnId_t  connId,
uint16_t  fileHdl,
uint32_t  offset,
uint32_t  len,
uint32_t  fileSize,
uint8_t  type 
)

Send a request to put a block of data into a file on the peer device.

Parameters
connIdConnection ID.
fileHdlHandle of file on peer device
offsetThe offset from the beginning of the file in bytes
lenThe number of bytes to put
fileSizeThe size of the file in bytes
typereserved
Returns
None.
void WdxcFtcSendGetReq ( dmConnId_t  connId,
uint16_t  fileHdl,
uint32_t  offset,
uint32_t  len,
uint8_t  type 
)

Send a request to perform a get a block of data from a file on the peer device.

Parameters
connIdConnection ID.
fileHdlHandle of file to verify on peer device
offsetThe offset from the beginning of the file in bytes
lenThe number of bytes to get
typereserved
Returns
None.
void WdxcFtdSendBlock ( dmConnId_t  connId,
uint32_t  len,
uint8_t pData 
)

Send a data block to the peer device.

Parameters
connIdConnection ID.
lenSize of pData in bytes
pDataData to put to the file
Returns
None.
void WdxsAuthenticationCfg ( bool_t  reqLevel,
uint8_t pKey 
)

Called at startup to configure WDXS authentication.

Parameters
reqLevelLevel of authentication that is required for a client to use WDXS
pKeyAuthentication key (set to NULL if no authentication is required)
Returns
None.
void WdxsHandler ( wsfEventMask_t  event,
wsfMsgHdr_t pMsg 
)

Handle WSF events for WDXS.

Parameters
eventevent
pMsgmessage assiciated with event
Returns
None.
void WdxsHandlerInit ( wsfHandlerId_t  handlerId)

WSF Task Initialization for WDXS task.

Parameters
handlerIdID of the WDXS task
Returns
None.
uint8_t WdxsAttCback ( attEvt_t pEvt)

Called by application to notify the WDXS of ATT Events.

Parameters
pEvtPointer to the ATT Event
Returns
TRUE if the application should ignore the event, else FALSE.
void WdxsProcDmMsg ( dmEvt_t pEvt)

Called by application to notify the WDXS of DM Events.

Parameters
pEvtPointer to the DM Event
Returns
None.
void WdxsSetCccIdx ( uint8_t  dcCccIdx,
uint8_t  auCccIdx,
uint8_t  ftcCccIdx,
uint8_t  ftdCccIdx 
)

Set the CCCD index used by the application for WDXS service characteristics.

Parameters
dcCccIdxDevice Control CCCD index.
auCccIdxAuthentication CCCD index.
ftcCccIdxFile Transfer Control CCCD index.
ftdCccIdxFile Transfer Data CCCD index.
Returns
None.
void WdxsFlashMediaInit ( void  )

Registers the platform dependent Flash Media with the Embedded File System (EFS)

Returns
None.
void WdxsOtaMediaInit ( void  )

Registers the platform dependent OTA Media with the Embedded File System (EFS)

Returns
None.
void WdxsResetSystem ( void  )

Resets the system.

Returns
None.
void WdxsPhyInit ( void  )

Initialize WDXS Device Configuration PHY.

Returns
None.
void wdxsDcSend ( dmConnId_t  connId)

Send device configuration notification.

Parameters
connIdDM connection identifier.
Returns
None.
void wdxsFtcSend ( dmConnId_t  connId)

Send a file transfer control characteristic notification.

Parameters
connIdDM connection identifier.
Returns
None.
void wdxsFtdSend ( dmConnId_t  connId)

Send a file transfer data characteristic notification.

Parameters
connIdDM connection identifier.
Returns
None.
void wdxsAuSend ( dmConnId_t  connId)

Transmit to authentication characteristic.

Parameters
connIdDM connection identifier.
Returns
ATT status.
uint8_t wdxsDcWrite ( dmConnId_t  connId,
uint16_t  len,
uint8_t pValue 
)

Process a write to the device configuration characteristic.

Parameters
connIdDM connection identifier.
lenLength to write.
pValuevalue to write.
Returns
ATT status.
uint8_t wdxsFtcWrite ( dmConnId_t  connId,
uint16_t  len,
uint8_t pValue 
)

Process a write to the file transfer control characteristic.

Parameters
connIdDM connection identifier.
lenLength to write.
pValueValue to write.
Returns
ATT status.
uint8_t wdxsFtdWrite ( dmConnId_t  connId,
uint16_t  len,
uint8_t pValue 
)

Process a write to the file transfer data characteristic.

Parameters
connIdDM connection identifier.
lenLength to write.
pValueValue to write.
Returns
ATT status.
uint8_t wdxsAuWrite ( dmConnId_t  connId,
uint16_t  len,
uint8_t pValue 
)

Process a write to the authentication characteristic.

Parameters
connIdDM connection identifier.
lenLength to write.
pValueValue to write
Returns
ATT status.
uint8_t wdxsDcUpdateConnParam ( dmConnId_t  connId,
uint8_t  status 
)

Send update message for connection parameters.

Parameters
connIdDM connection identifier.
statusUpdate status.
Returns
ATT status.
uint8_t wdxsDcUpdatePhy ( dmConnId_t  connId,
uint8_t  status 
)

Send update message for PHY.

Parameters
connIdDM connection identifier.
statusUpdate status.
Returns
ATT status.
void wdxsDcPhyRegister ( wdxsDcPhyWriteCback_t  cback)

Register a PHY write callback for the device configuration characteristic.

Parameters
cbackPHY callback function.
Returns
None.
void WdxsUpdateListing ( void  )

Create the file list.

Returns
none.
void wdxsStreamInit ( void  )

Example of creating a WDXS stream.

Returns
None.
void wdxsSetStreamWaveform ( uint8_t  type)

Changes the type of waveform transmitted by the stream.

Parameters
type- Identifier of the waveform
Returns
None.