NXP / fsl_phy_mcr20a

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of fsl_phy_mcr20a by Freescale

Embed: (wiki syntax)

« Back to documentation index

PhyPlmeData.c File Reference
Functions

PhyPlmeData.c File Reference

Go to the source code of this file.

Functions

phyStatus_t PhyPdDataRequest (pdDataReq_t *pTxPacket, volatile phyRxParams_t *pRxParams, volatile phyTxParams_t *pTxParams)
 This function will start a TX sequence. The packet will be sent OTA.
phyStatus_t PhyPlmeRxRequest (phySlottedMode_t phyRxMode, phyRxParams_t *pRxParams)
 This function will start a RX sequence.
phyStatus_t PhyPlmeCcaEdRequest (phyCCAType_t ccaParam, phyContCCAMode_t cccaMode)
 This function will start a CCA / CCCA sequence.
phyStatus_t PhyPlmeSetCurrentChannelRequest (uint8_t channel, uint8_t pan)
 This function will set the channel number for the specified PAN.
uint8_t PhyPlmeGetCurrentChannelRequest (uint8_t pan)
 This function will return the current channel for a specified PAN.
phyStatus_t PhyPlmeSetPwrLevelRequest (uint8_t pwrStep)
 This function will set the radio Tx power.
phyStatus_t PhyPlmeSetPIBRequest (phyPibId_t pibId, uint64_t pibValue, uint8_t phyRegistrySet, instanceId_t instanceId)
 This function will set the value of PHY PIBs.
phyStatus_t PhyPlmeGetPIBRequest (phyPibId_t pibId, uint64_t *pibValue, uint8_t phyRegistrySet, instanceId_t instanceId)
 This function will return the value of PHY PIBs.

Detailed Description

Copyright (c) 2015, Freescale Semiconductor, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

o Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

o Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

o Neither the name of Freescale Semiconductor, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file PhyPlmeData.c.

Function Documentation

phyStatus_t PhyPdDataRequest ( pdDataReq_t *  pTxPacket,
volatile phyRxParams_t *  pRxParams,
volatile phyTxParams_t *  pTxParams 
)

This function will start a TX sequence. The packet will be sent OTA.

*********************************************************************************

Parameters:
[in]pTxPacketpointer to the TX packet structure
[in]pRxParamspointer to RX parameters
[in]pTxParamspointer to TX parameters
Returns:
phyStatus_t

Definition at line 98 of file PhyPlmeData.c.

phyStatus_t PhyPlmeCcaEdRequest ( phyCCAType_t  ccaParam,
phyContCCAMode_t  cccaMode 
)

This function will start a CCA / CCCA sequence.

*********************************************************************************

Parameters:
[in]ccaParamthe type of CCA
[in]cccaModecontinuous or single CCA
Returns:
phyStatus_t

Definition at line 318 of file PhyPlmeData.c.

uint8_t PhyPlmeGetCurrentChannelRequest ( uint8_t  pan )

This function will return the current channel for a specified PAN.

*********************************************************************************

Parameters:
[in]panthe PAN registers (0/1)
Returns:
uint8_t current channel number

Definition at line 434 of file PhyPlmeData.c.

phyStatus_t PhyPlmeGetPIBRequest ( phyPibId_t  pibId,
uint64_t *  pibValue,
uint8_t  phyRegistrySet,
instanceId_t  instanceId 
)

This function will return the value of PHY PIBs.

*********************************************************************************

Parameters:
[in]pibIdthe Id of the PIB
[out]pibValuepointer to a location where the value will be stored
[in]phyRegistrySetthe PAN registers (0/1)
[in]instanceIdthe instance of the PHY
Returns:
phyStatus_t

Definition at line 596 of file PhyPlmeData.c.

phyStatus_t PhyPlmeRxRequest ( phySlottedMode_t  phyRxMode,
phyRxParams_t *  pRxParams 
)

This function will start a RX sequence.

*********************************************************************************

Parameters:
[in]phyRxModeslotted/unslotted
[in]pRxParamspointer to RX parameters
Returns:
phyStatus_t

Definition at line 235 of file PhyPlmeData.c.

phyStatus_t PhyPlmeSetCurrentChannelRequest ( uint8_t  channel,
uint8_t  pan 
)

This function will set the channel number for the specified PAN.

*********************************************************************************

Parameters:
[in]channelnew channel number
[in]panthe PAN registers (0/1)
Returns:
phyStatus_t

Definition at line 397 of file PhyPlmeData.c.

phyStatus_t PhyPlmeSetPIBRequest ( phyPibId_t  pibId,
uint64_t  pibValue,
uint8_t  phyRegistrySet,
instanceId_t  instanceId 
)

This function will set the value of PHY PIBs.

*********************************************************************************

Parameters:
[in]pibIdthe Id of the PIB
[in]pibValuethe new value of the PIB
[in]phyRegistrySetthe PAN registers (0/1)
[in]instanceIdthe instance of the PHY
Returns:
phyStatus_t

Definition at line 507 of file PhyPlmeData.c.

phyStatus_t PhyPlmeSetPwrLevelRequest ( uint8_t  pwrStep )

This function will set the radio Tx power.

*********************************************************************************

Parameters:
[in]pwrStepthe Tx power
Returns:
phyStatus_t

Definition at line 453 of file PhyPlmeData.c.

Generated on Fri Jul 15 2022 21:41:18 by  doxygen 1.7.2