Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Static Public Member Functions
NanostackRfPhy Class Referenceabstract

Radio PHY driver class for Nanostack. More...

#include <NanostackRfPhy.h>

Inheritance diagram for NanostackRfPhy:
NanostackMACPhy NanostackPhy

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...
 
virtual int8_t phy_register ()
 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...
 
virtual NanostackMACPhynanostack_mac_phy ()
 Provide access to the NanostackMACPhy. More...
 
virtual NanostackPPPPhynanostack_ppp_phy ()
 Return pointer to a NanostackPPPPhy. More...
 

Static Public Member Functions

static NanostackRfPhyget_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

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.

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
macmac address
virtual NanostackMACPhy* nanostack_mac_phy ( )
virtualinherited

Provide access to the NanostackMACPhy.

Returns
NanostackMACPhy

Reimplemented from NanostackPhy.

Definition at line 45 of file NanostackMACPhy.h.

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.

virtual int8_t phy_register ( )
virtual

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.

virtual int8_t rf_register ( )
pure virtual

Register this physical interface with Nanostack.

Returns
Device driver ID or a negative error code on failure
virtual void rf_unregister ( )
pure virtual

Unregister this physical interface.

virtual void set_mac_address ( uint8_t *  mac)
pure virtualinherited

Set the mac address of this physical interface.

Parameters
macmac address
virtual void unregister ( )
virtual

Unregister this physical interface.

Definition at line 59 of file NanostackRfPhy.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.