NanostackRfPhy Class Reference

Radio PHY driver class for Nanostack. More...

#include <NanostackRfPhy.h>

Inheritance diagram for NanostackRfPhy:

Public Member Functions
virtual int8_t	rf_register ()=0
	Register this physical interface with Nanostack. More...
virtual void	rf_unregister ()=0
	Unregister this physical interface. More...
int8_t	phy_register () override
	Register this physical interface with Nanostack. More...
virtual void	unregister ()
	Unregister this physical interface. More...
virtual void	get_mac_address (uint8_t *mac)=0
	Read the mac address of this physical interface. More...
virtual void	set_mac_address (uint8_t *mac)=0
	Set the mac address of this physical interface. More...
NanostackMACPhy *	nanostack_mac_phy () final
	Provide access to the NanostackMACPhy. More...
virtual NanostackPPPPhy *	nanostack_ppp_phy ()
	Return pointer to a NanostackPPPPhy. More...

Static Public Member Functions
static NanostackRfPhy &	get_default_instance ()
	Return the default on-board NanostackRfPhy. More...

Detailed Description

Radio PHY driver class for Nanostack.

Definition at line 24 of file NanostackRfPhy.h.

Member Function Documentation

get_default_instance()

static NanostackRfPhy & get_default_instance ( )

static

Return the default on-board NanostackRfPhy.

Returns the default on-board NanostackRfPhy - this will be target-specific, and may not be available on all targets.

rf_register()

virtual int8_t rf_register ( )

pure virtual

Register this physical interface with Nanostack.

Returns

Device driver ID or a negative error code on failure

rf_unregister()

virtual void rf_unregister ( )

pure virtual

Unregister this physical interface.

phy_register()

int8_t phy_register ( )

overridevirtual

Register this physical interface with Nanostack.

Returns

Device driver ID or a negative error code on failure

Implements NanostackPhy.

Definition at line 51 of file NanostackRfPhy.h.

unregister()

virtual void unregister ( )

virtual

Unregister this physical interface.

Definition at line 59 of file NanostackRfPhy.h.

get_mac_address()

virtual void get_mac_address ( uint8_t *  mac )

pure virtualinherited

Read the mac address of this physical interface.

Note - some devices do not have a mac address in hardware.

Parameters

mac	mac address

set_mac_address()

virtual void set_mac_address ( uint8_t *  mac )

pure virtualinherited

Set the mac address of this physical interface.

Parameters

mac	mac address

nanostack_mac_phy()

NanostackMACPhy * nanostack_mac_phy ( )

finalvirtualinherited

Provide access to the NanostackMACPhy.

Returns

NanostackMACPhy

Reimplemented from NanostackPhy.

Definition at line 45 of file NanostackMACPhy.h.

nanostack_ppp_phy()

virtual NanostackPPPPhy * nanostack_ppp_phy ( )

virtualinherited

Return pointer to a NanostackPPPPhy.

Returns

Pointer to requested phy type or NULL if this class doesn't implement the phy.

Reimplemented in NanostackPPPPhy.

Definition at line 50 of file NanostackPhy.h.