Rtos API example

Embed: (wiki syntax)

« Back to documentation index

sw_mac.h File Reference

sw_mac.h File Reference

Software MAC API. More...

Go to the source code of this file.

Functions

struct mac_api_sns_sw_mac_create (int8_t rf_driver_id, struct mac_description_storage_size_s *storage_sizes)
 Creates 802.15.4 MAC API instance which will use RF driver given.
int8_t ns_sw_mac_virtual_client_register (struct mac_api_s *api, int8_t virtual_driver_id)
 ns_sw_mac_virtual_client_register registers virtual driver to be used with 802.15.4 MAC.
int8_t ns_sw_mac_virtual_client_unregister (struct mac_api_s *api)
 ns_sw_mac_virtual_client_unregister Unregisters virtual driver from 802.15.4 MAC
int ns_sw_mac_fhss_register (struct mac_api_s *mac_api, struct fhss_api *fhss_api)
 Registers created FHSS API instance to given software MAC instance.

Detailed Description

Software MAC API.

Definition in file sw_mac.h.


Function Documentation

struct mac_api_s* ns_sw_mac_create ( int8_t  rf_driver_id,
struct mac_description_storage_size_s *  storage_sizes 
) [read]

Creates 802.15.4 MAC API instance which will use RF driver given.

Parameters:
rf_driver_idRF driver id. Must be valid
storage_sizesdynamic mac storage sizes DO NOT set any values to zero !!
Returns:
New MAC instance if successful, NULL otherwise
int ns_sw_mac_fhss_register ( struct mac_api_s mac_api,
struct fhss_api fhss_api 
)

Registers created FHSS API instance to given software MAC instance.

Parameters:
mac_apiMAC instance.
fhss_apiFHSS instance.
Returns:
0 on success, -1 on fail.
int8_t ns_sw_mac_virtual_client_register ( struct mac_api_s api,
int8_t  virtual_driver_id 
)

ns_sw_mac_virtual_client_register registers virtual driver to be used with 802.15.4 MAC.

This is always used with serial_mac_api

Parameters:
apiAPI to start using virtual driver
virtual_driver_id
Returns:
0 if success, -1 if api or driver is invalid
int8_t ns_sw_mac_virtual_client_unregister ( struct mac_api_s api )

ns_sw_mac_virtual_client_unregister Unregisters virtual driver from 802.15.4 MAC

Parameters:
apiAPI from which to unregister virtual driver
Returns:
0 if success, -1 if api is invalid