wwd_thread.h File Reference

Functions
wwd_result_t	wwd_thread_init (void)
void	wwd_thread_quit (void)
void	wwd_thread_set_tx_packet_filter (wwd_thread_filter_tx_packet_t tx_packet_callback, void *userdata)

Detailed Description

The Wiced Thread allows thread safe access to the Wiced hardware bus This is an Wiced internal file and should not be used by functions outside Wiced.

This file provides prototypes for functions which allow multiple threads to use the Wiced hardware bus (SDIO or SPI) This is achieved by having a single thread (the "Wiced Thread") which queues messages to be sent, sending them sequentially, as well as receiving messages as they arrive.

Messages to be sent come from the wwd_sdpcm_send_common function in wwd_sdpcm.c . The messages already contain SDPCM headers, but not any bus headers (GSPI), and are passed via a queue This function can be called from any thread.

Messages are received by way of a callback supplied by in wwd_sdpcm.c - wwd_sdpcm_process_rx_packet Received messages are delivered in the context of the Wiced Thread, so the callback function needs to avoid blocking.

Function Documentation

wwd_thread_init()

wwd_result_t wwd_thread_init ( void )

extern

Initialises the Wiced Thread

Initialises the Wiced thread, and its flags/semaphores, then starts it running

Returns

wiced result code

Initialises the WWD Thread

Initialises the WWD thread, and its flags/semaphores, then starts it running

Returns

WWD_SUCCESS : if initialisation succeeds otherwise, a result code

wwd_thread_quit()

void wwd_thread_quit ( void )

extern

Terminates the Wiced Thread

Sets a flag then wakes the Wiced Thread to force it to terminate.

Terminates the WWD Thread

Sets a flag then wakes the WWD Thread to force it to terminate.

wwd_thread_set_tx_packet_filter()

void wwd_thread_set_tx_packet_filter ( wwd_thread_filter_tx_packet_t tx_packet_callback, void * userdata )

extern

Called by a WICED application to filter outgoing packets before they are passed to the wlan CPU.

NOTE: The packet passed to the filter callback will be processed normally when the callback returns. IMPORTANT: This functionality must be used with extreme care. The callback will be called in the context of the WWD thread which normally operates with a very small stack. And delays in processing will significantly impact network performance.

Parameters

tx_packet_callback	: Callback routine to invoke when packet is sent.
userdata	: Opaque data pointer to pass back to application in callback.