Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

NanostackRfPhy Class Reference

NanostackRfPhy Class Reference

Radio PHY driver class for Nanostack. More...

#include <NanostackRfPhy.h>

Inherits NanostackMACPhy.

Inherited by NanostackRfPhyAtmel, NanostackRfPhyMcr20a, and NanostackRfPhys2lp.

Public Member Functions

virtual int8_t rf_register ()=0
 Register this physical interface with Nanostack.
virtual void rf_unregister ()=0
 Unregister this physical interface.
virtual int8_t phy_register ()
 Register this physical interface with Nanostack.
virtual void unregister ()
 Unregister this physical interface.
virtual void get_mac_address (uint8_t *mac)=0
 Read the mac address of this physical interface.
virtual void set_mac_address (uint8_t *mac)=0
 Set the mac address of this physical interface.
virtual NanostackMACPhynanostack_mac_phy ()
 Provide access to the NanostackMACPhy.
virtual NanostackPPPPhynanostack_ppp_phy ()
 Return pointer to a NanostackPPPPhy.

Static Public Member Functions

static NanostackRfPhyget_default_instance ()
 Return the default on-board NanostackRfPhy.

Detailed Description

Radio PHY driver class for Nanostack.

Definition at line 24 of file NanostackRfPhy.h.


Member Function Documentation

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.

Definition at line 2263 of file NanostackRfPhyAtmel.cpp.

virtual void get_mac_address ( uint8_t *  mac ) [pure virtual, inherited]

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 (  ) [virtual, inherited]

Provide access to the NanostackMACPhy.

Returns:
NanostackMACPhy

Reimplemented from NanostackPhy.

Definition at line 45 of file NanostackMACPhy.h.

virtual NanostackPPPPhy* nanostack_ppp_phy (  ) [virtual, inherited]

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 virtual, inherited]

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.