NXP / fsl_phy_mcr20a

Fork of fsl_phy_mcr20a by Freescale

Embed: (wiki syntax)

« Back to documentation index

PhyInterface.h File Reference

PhyInterface.h File Reference

Go to the source code of this file.

Functions

void Phy_Init (void)
 This function creates the PHY task.
instanceId_t BindToPHY (instanceId_t macInstance)
 This function binds a MAC instance to a PHY instance.
void Phy_RegisterSapHandlers (PD_MAC_SapHandler_t pPD_MAC_SapHandler, PLME_MAC_SapHandler_t pPLME_MAC_SapHandler, instanceId_t instanceId)
 This function registers the MAC PD and PLME SAP handlers.
phyStatus_t MAC_PD_SapHandler (macToPdDataMessage_t *pMsg, instanceId_t phyInstance)
 This is the PD SAP message handler.
phyStatus_t MAC_PLME_SapHandler (macToPlmeMessage_t *pMsg, instanceId_t phyInstance)
 This is the PLME SAP message handler.
void PhyTime_Maintenance (void)
 Expire events too close to be scheduled. Program the next event.
void PhyTime_RunCallback (void)
 Run the callback for the recently expired event.
void PhyTime_ISR (void)
 PHY Timer Interrupt Service Routine.
phyTimeStatus_t PhyTime_TimerInit (void(*cb)(void))
 Initialize the PHY Timer module.
phyTimeTimestamp_t PhyTime_GetTimestamp (void)
 Returns a 64bit timestamp value to be used by the MAC Layer.
phyTimeTimerId_t PhyTime_ScheduleEvent (phyTimeEvent_t *pEvent)
 Schedules an event.
phyTimeStatus_t PhyTime_CancelEvent (phyTimeTimerId_t timerId)
 Cancel an event.
phyTimeStatus_t PhyTime_CancelEventsWithParam (uint32_t param)
 Cancel all event with the specified paameter.

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 PhyInterface.h.


Function Documentation

instanceId_t BindToPHY ( instanceId_t  macInstance )

This function binds a MAC instance to a PHY instance.

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

Parameters:
[in]instanceIdThe instance of the MAC
Returns:
The instance of the PHY.

Definition at line 152 of file PhyStateMachine.c.

phyStatus_t MAC_PD_SapHandler ( macToPdDataMessage_t *  pMsg,
instanceId_t  phyInstance 
)

This is the PD SAP message handler.

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

Parameters:
[in]pMsgPointer to the PD request message
[in]instanceIdThe instance of the PHY
Returns:
The status of the operation.

Definition at line 308 of file PhyStateMachine.c.

phyStatus_t MAC_PLME_SapHandler ( macToPlmeMessage_t *  pMsg,
instanceId_t  phyInstance 
)

This is the PLME SAP message handler.

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

Parameters:
[in]pMsgPointer to the PLME request message
[in]instanceIdThe instance of the PHY
Returns:
phyStatus_t The status of the operation.

Definition at line 360 of file PhyStateMachine.c.

void Phy_Init ( void   )

This function creates the PHY task.

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

Definition at line 123 of file PhyStateMachine.c.

void Phy_RegisterSapHandlers ( PD_MAC_SapHandler_t  pPD_MAC_SapHandler,
PLME_MAC_SapHandler_t  pPLME_MAC_SapHandler,
instanceId_t  instanceId 
)

This function registers the MAC PD and PLME SAP handlers.

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

Parameters:
[in]pPD_MAC_SapHandlerPointer to the MAC PD handler function
[in]pPLME_MAC_SapHandlerPointer to the MAC PLME handler function
[in]instanceIdThe instance of the PHY
Returns:
The status of the operation.

Definition at line 167 of file PhyStateMachine.c.

phyTimeStatus_t PhyTime_CancelEvent ( phyTimeTimerId_t  timerId )

Cancel an event.

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

Parameters:
[in]timerIdthe Id of the timer
Returns:
phyTimeStatus_t

Definition at line 546 of file PhyTime.c.

phyTimeStatus_t PhyTime_CancelEventsWithParam ( uint32_t  param )

Cancel all event with the specified paameter.

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

Parameters:
[in]paramevent parameter
Returns:
phyTimeStatus_t

Definition at line 571 of file PhyTime.c.

phyTimeTimestamp_t PhyTime_GetTimestamp ( void   )

Returns a 64bit timestamp value to be used by the MAC Layer.

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

Returns:
phyTimeTimestamp_t PHY timestamp

Definition at line 483 of file PhyTime.c.

void PhyTime_ISR ( void   )

PHY Timer Interrupt Service Routine.

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

Definition at line 435 of file PhyTime.c.

void PhyTime_Maintenance ( void   )

Expire events too close to be scheduled. Program the next event.

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

Definition at line 621 of file PhyTime.c.

void PhyTime_RunCallback ( void   )

Run the callback for the recently expired event.

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

Definition at line 596 of file PhyTime.c.

phyTimeTimerId_t PhyTime_ScheduleEvent ( phyTimeEvent_t *  pEvent )

Schedules an event.

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

Parameters:
[in]pEventevent to be scheduled
Returns:
phyTimeTimerId_t the id of the alocated timer

Definition at line 503 of file PhyTime.c.

phyTimeStatus_t PhyTime_TimerInit ( void(*)(void)  cb )

Initialize the PHY Timer module.

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

Returns:
phyTimeStatus_t

Definition at line 459 of file PhyTime.c.