/*******************************************************************************
Function:
void WF_PsPollEnable(t_psPollContext *p_context)
Summary:
Enables PS Poll mode.
Description:
Enables PS Poll mode. PS-Poll (Power-Save Poll) is a mode allowing for
longer battery life. The MRF24W coordinates with the Access Point to go
to sleep and wake up at periodic intervals to check for data messages, which
the Access Point will buffer. The listenInterval in the Connection
Algorithm defines the sleep interval. By default, PS-Poll mode is disabled.
When PS Poll is enabled, the WF Host Driver will automatically force the
MRF24W to wake up each time the Host sends Tx data or a control message
to the MRF24W. When the Host message transaction is complete the
MRF24W driver will automatically re-enable PS Poll mode.
When the application is likely to experience a high volume of data traffic
then PS-Poll mode should be disabled for two reasons:
1. No power savings will be realized in the presence of heavy data traffic.
2. Performance will be impacted adversely as the WiFi Host Driver
continually activates and deactivates PS-Poll mode via SPI messages.
Precondition:
MACInit must be called first.
Parameters:
p_context - pointer to ps poll context
Returns:
None.
Remarks:
None.
*****************************************************************************/
void WF_PsPollEnable(t_psPollContext *p_context)
{
t_WFPwrModeReq pwrModeReq;
// if not currently connected then return
if(UdGetConnectionState() != CS_CONNECTED)
{
EventEnqueue(WF_EVENT_ERROR, UD_INVALID_PS_POLL_ERROR);
return;
}
// save the Ps-Poll context
UdEnablePsPoll(p_context);
SetListenInterval(p_context->listenInterval);
SetDtimInterval(p_context->dtimInterval);
// fill in request structure and send message to MRF24WG
pwrModeReq.mode = PS_POLL_ENABLED;
pwrModeReq.wake = 0;
pwrModeReq.rcvDtims = p_context->useDtim;
SendPowerModeMsg(&pwrModeReq);
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
if (p_context->useDtim)
{
PowerStateSet(WF_PS_PS_POLL_DTIM_ENABLED);
}
else
{
PowerStateSet(WF_PS_PS_POLL_DTIM_DISABLED);
}
}
/*******************************************************************************
Function:
void WF_PsPollEnable(bool rxDtim, bool aggressive)
Summary:
Enables PS Poll mode.
Description:
Enables PS Poll mode. PS-Poll (Power-Save Poll) is a mode allowing for
longer battery life. The MRF24W coordinates with the Access Point to go
to sleep and wake up at periodic intervals to check for data messages, which
the Access Point will buffer. The listenInterval in the Connection
Algorithm defines the sleep interval. By default, PS-Poll mode is disabled.
When PS Poll is enabled, the WF Host Driver will automatically force the
MRF24W to wake up each time the Host sends Tx data or a control message
to the MRF24W. When the Host message transaction is complete the
MRF24W driver will automatically re-enable PS Poll mode.
When the application is likely to experience a high volume of data traffic
then PS-Poll mode should be disabled for two reasons:
1. No power savings will be realized in the presence of heavy data traffic.
2. Performance will be impacted adversely as the WiFi Host Driver
continually activates and deactivates PS-Poll mode via SPI messages.
Precondition:
MACInit must be called first.
Parameters:
rxDtim - true if MRF24W should wake up periodically and check for
buffered broadcast messages, else false
Returns:
None.
Remarks:
None.
*****************************************************************************/
void WF_PsPollEnable(bool rxDtim, bool aggressive)
{
tWFPwrModeReq pwrModeReq;
if (isWiFiVer1209OrLater() && !WFisConnected())
{
// save caller parameters for later, when we can enable this mode
g_rxDtim = rxDtim;
g_aggressivePs = aggressive;
SetAppPowerSaveMode(true);
return;
}
/* fill in request structure and send message to MRF24W */
pwrModeReq.mode = PS_POLL_ENABLED;
pwrModeReq.wake = 0;
pwrModeReq.rcvDtims = rxDtim;
pwrModeReq.reserved = aggressive;
SendPowerModeMsg(&pwrModeReq);
if (rxDtim == true)
{
SetPowerSaveState(WF_PS_PS_POLL_DTIM_ENABLED);
}
else
{
SetPowerSaveState(WF_PS_PS_POLL_DTIM_DISABLED);
}
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
SetAppPowerSaveMode(true);
}
void WiFiTask(void)
{
#if defined (WF_USE_POWER_SAVE_FUNCTIONS)
//--------------------------------------------------------------------------
// if not waiting for a mgmt response and the application wants PS-Poll Mode
//--------------------------------------------------------------------------
if ((!g_WaitingForMgmtResponse) && (GetAppPowerSaveMode() == TRUE))
{
// else if changed from connected to disconnected, or vice-versa
if (g_WiFiConnectionChanged == TRUE)
{
g_WiFiConnectionChanged = FALSE;
// if lost connection
if (g_WiFiConnection == FALSE)
{
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
// else connected (or reconnected)
else
{
// if not using DHCP
if (AppConfig.Flags.bIsDHCPEnabled == FALSE)
{
WF_PsPollEnable(g_rxDtim);
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
}
// note: if using DHCP, another case will reenable PS-Poll mode
}
}
// else if app is using DHCP and we just got an IP address via DHCP
else if ((AppConfig.Flags.bIsDHCPEnabled == TRUE) && (g_DhcpSuccessful == TRUE))
{
g_DhcpSuccessful = FALSE;
WF_PsPollEnable(g_rxDtim);
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
}
// if application wants PS-Poll, but the driver disabled it to send a message (and not waiting for DHCP)
else if ( g_WiFiConnection == TRUE && isSleepNeeded() && !isDhcpInProgress() )
{
ClearSleepNeeded();
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
}
}
#endif /* WF_USE_POWER_SAVE_FUNCTIONS */
}
void EnsureWFisAwake(void)
{
// if the application has enabled PS mode
if ((g_powerSaveState == WF_PS_PS_POLL_DTIM_ENABLED) || (g_powerSaveState == WF_PS_PS_POLL_DTIM_DISABLED))
{
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF); // wake up MRF24WG
SetPsPollReactivate(); // set flag to put it back in PS-Poll when appropriate
}
}
/*****************************************************************************
* FUNCTION: WFHardwareInit
*
* RETURNS: error code
*
* PARAMS: None
*
* NOTES: Initializes CPU Host hardware interfaces (SPI, External Interrupt).
* Also resets the MRF24W.
*****************************************************************************/
void WFHardwareInit(void)
{
UINT8 mask8;
UINT16 mask16;
g_MgmtReadMsgReady = FALSE;
g_ExIntNeedsServicing = FALSE;
RawMoveState.rawInterrupt = 0;
RawMoveState.waitingForRawMoveCompleteInterrupt = FALSE; /* not waiting for RAW move complete */
/* needed for Microchip PICTail (chip enable active low) */
WF_SetCE_N(WF_LOW); /* set low to enable regulator */
/* initialize the SPI interface */
WF_SpiInit();
ResetPll(); // needed until PLL fix made in A2 silicon
/* Reset the MRF24W (using SPI bus to write/read MRF24W registers */
ChipReset();
/* disable the interrupts gated by the 16-bit host int register */
HostInterrupt2RegInit(WF_HOST_2_INT_MASK_ALL_INT, (UINT16)WF_INT_DISABLE);
/* disable the interrupts gated the by main 8-bit host int register */
HostInterruptRegInit(WF_HOST_INT_MASK_ALL_INT, WF_INT_DISABLE);
/* Initialize the External Interrupt for the MRF24W allowing the MRF24W to interrupt */
/* the Host from this point forward. */
WF_EintInit();
WF_EintEnable();
/* enable the following MRF24W interrupts in the INT1 8-bit register */
mask8 = (WF_HOST_INT_MASK_FIFO_1_THRESHOLD | /* Mgmt Rx Msg interrupt */
WF_HOST_INT_MASK_FIFO_0_THRESHOLD | /* Data Rx Msg interrupt */
WF_HOST_INT_MASK_RAW_0_INT_0 | /* RAW0 Move Complete (Data Rx) interrupt */
WF_HOST_INT_MASK_RAW_1_INT_0 | /* RAW1 Move Complete (Data Tx) interrupt */
WF_HOST_INT_MASK_INT2); /* Interrupt 2 interrupt */
HostInterruptRegInit(mask8, WF_INT_ENABLE);
/* enable the following MRF24W interrupts in the INT2 16-bit register */
mask16 = (WF_HOST_INT_MASK_RAW_2_INT_0 | /* RAW2 Move Complete (Mgmt Rx) interrupt */
WF_HOST_INT_MASK_RAW_3_INT_0 | /* RAW3 Move Complete (Mgmt Tx) interrupt */
WF_HOST_INT_MASK_RAW_4_INT_0 | /* RAW4 Move Complete (Scratch) interrupt */
WF_HOST_INT_MASK_RAW_5_INT_0 | /* RAW5 Move Complete (Scratch) interrupt */
WF_HOST_INT_MASK_MAIL_BOX_0_WRT);
HostInterrupt2RegInit(mask16, WF_INT_ENABLE);
/* Disable PS-Poll mode */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
void SetDhcpProgressState(void)
{
g_dhcpInProgress = true;
// disable power save mode while DHCP in progress
if (GetAppPowerSaveMode() == true)
{
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
}
static void PsPollCheck(void)
{
// if PS-Poll was disabled temporarily and needs to be reenabled, and, we are in
// a connected state
if ((isPsPollNeedReactivate()) && (UdGetConnectionState() == CS_CONNECTED))
{
ClearPsPollReactivate();
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
}
}
/*******************************************************************************
Function:
void WF_PsPollDisable(void)
Summary:
Disables PS-Poll mode.
Description:
Disables PS Poll mode. The MRF24WB0M will stay active and not go sleep.
Precondition:
MACInit must be called first.
Parameters:
None.
Returns:
None.
Remarks:
None.
*****************************************************************************/
void WF_PsPollDisable(void)
{
tWFPwrModeReq pwrModeReq;
pwrModeReq.mode = PS_POLL_DISABLED;
pwrModeReq.wake = 1;
pwrModeReq.rcvDtims = 1;
SendPowerModeMsg(&pwrModeReq);
SetPowerSaveState(WF_PS_OFF);
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
/*****************************************************************************
* FUNCTION: WFProcess
*
* RETURNS: None
*
* PARAMS: None
*
* NOTES: This function is called from WFProcess. It does the following:
* 1) checks for and processes MRF24WB0M external interrupt events
* 2) checks for and processes received management messages from the MRF24WB0M
* 3) maintains the PS-Poll state (if applicable)
*
*****************************************************************************/
void WFProcess(void)
{
UINT16 len;
//----------------------------------------------------------
// if there is a MRF24WB0M External interrupt (EINT) to process
//----------------------------------------------------------
if (g_ExIntNeedsServicing == TRUE)
{
g_ExIntNeedsServicing = FALSE;
ProcessInterruptServiceResult();
}
//----------------------------------------
// else if there is management msg to read
//----------------------------------------
else if (g_MgmtReadMsgReady == TRUE)
{
/* Ensure the MRF24WB0M is awake (only applies if PS-Poll was enabled) */
EnsureWFisAwake();
//-----------------------------
// process management read
//-----------------------------
// if the Raw Rx buffer is available, or only has the scratch mounted, then mount it so
// we can process received Mgmt message. Otherwise, stay in this state and keep checking
// until we can mount the Raw Rx buffer and get the management message. Once the Raw Rx
// is acquired, rx data packets are held off until we finish processing mgmt message.
if ( RawGetMgmtRxBuffer(&len) )
{
// handle received managment message
g_MgmtReadMsgReady = FALSE;
ProcessMgmtRxMsg();
// reenable interrupts
WF_EintEnable();
}
}
//-----------------------------------
// else no EINT or Mgmt Rx to process
//-----------------------------------
else
{
#if defined (WF_USE_POWER_SAVE_FUNCTIONS)
/* if PS-Poll mode was enabled by application and was previously deactivated by WF driver */
if (WFisPsPollEnabled() && !WFIsPsPollActive() )
{
/* reactivate PS-Poll mode on MRF24WB0M (allow MRF24WB0M to sleep) */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
}
#endif
}
}
/*******************************************************************************
Function:
void DRV_WIFI_PsPollDisable(void)
Summary:
Disables PS-Poll mode.
Description:
Disables PS Poll mode. The MRF24W will stay active and not go sleep.
Parameters:
None.
Returns:
None.
Remarks:
None.
*******************************************************************************/
void DRV_WIFI_PsPollDisable(void)
{
t_wfPwrModeReq pwrModeReq;
pwrModeReq.mode = PS_POLL_DISABLED;
pwrModeReq.wake = 1;
pwrModeReq.rcvDtims = 1;
SendPowerModeMsg(&pwrModeReq);
SetPowerSaveState(DRV_WIFI_PS_OFF);
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
SetAppPowerSaveMode(false);
}
/*******************************************************************************
Function:
void EnsureWFisAwake()
Summary:
If PS-Poll is active or the MRF24WB0M is asleep, ensure that it is woken up.
Description:
Called by the WiFi driver when it needs to transmit or receive a data or
mgmt message. If the application has enabled PS-Poll mode and the WiFi
driver has activated PS-Poll mode then this function will deactivate PS-Poll
mode and wake up the MRF24WB0M.
Precondition:
MACInit must be called first.
Parameters:
None.
Returns:
None.
Remarks:
None.
*****************************************************************************/
void EnsureWFisAwake()
{
/* if the application desires the MRF24WB0M to be in PS-Poll mode (PS-Poll with DTIM enabled or disabled */
if ((g_powerSaveState == WF_PS_PS_POLL_DTIM_ENABLED) || (g_powerSaveState == WF_PS_PS_POLL_DTIM_DISABLED))
{
/* if the WF driver has activated PS-Poll */
if (g_psPollActive == TRUE)
{
/* wake up MRF24WB0M */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
}
}
/*******************************************************************************
Function:
void WF_PsPollDisable(void)
Summary:
Disables PS-Poll mode.
Description:
Disables PS Poll mode. The MRF24W will stay active and not go sleep.
Precondition:
MACInit must be called first.
Parameters:
None.
Returns:
None.
Remarks:
None.
*****************************************************************************/
void WF_PsPollDisable(void)
{
UdDisablePsPoll();
t_WFPwrModeReq pwrModeReq;
pwrModeReq.mode = PS_POLL_DISABLED;
pwrModeReq.wake = 1;
pwrModeReq.rcvDtims = 1;
pwrModeReq.reserved = 0;
SendPowerModeMsg(&pwrModeReq);
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
PowerStateSet(WF_PS_OFF);
}
/*******************************************************************************
Function:
void EnsureWFisAwake()
Summary:
If PS-Poll is active or the MRF24W is asleep, ensure that it is woken up.
Description:
Called by the WiFi driver when it needs to transmit or receive a data or
mgmt message. If the application has enabled PS-Poll mode and the WiFi
driver has activated PS-Poll mode then this function will deactivate PS-Poll
mode and wake up the MRF24W.
Precondition:
MACInit must be called first.
Parameters:
None.
Returns:
None.
Remarks:
None.
*****************************************************************************/
void EnsureWFisAwake()
{
/* if the application desires the MRF24W to be in PS-Poll mode (PS-Poll with DTIM enabled or disabled */
if ((g_powerSaveState == WF_PS_PS_POLL_DTIM_ENABLED) || (g_powerSaveState == WF_PS_PS_POLL_DTIM_DISABLED))
{
/* if the WF driver has activated PS-Poll */
if (g_psPollActive == true)
{
/* wake up MRF24W */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
// will need to put device back into PS-Poll sleep mode after transaction
SetSleepNeeded();
}
}
/*******************************************************************************
Function:
void EnsureWFisAwake()
Summary:
If PS-Poll is active or the MRF24W is asleep, ensure that it is woken up.
Description:
Called by the WiFi driver when it needs to transmit or receive a data or
mgmt message. If the application has enabled PS-Poll mode and the WiFi
driver has activated PS-Poll mode then this function will deactivate PS-Poll
mode and wake up the MRF24W.
Precondition:
MACInit must be called first.
Parameters:
None.
Returns:
None.
Remarks:
None.
*****************************************************************************/
void EnsureWFisAwake()
{
/* if the application desires the MRF24W to be in PS-Poll mode (PS-Poll with DTIM enabled or disabled */
if ((g_powerSaveState == WF_PS_PS_POLL_DTIM_ENABLED) || (g_powerSaveState == WF_PS_PS_POLL_DTIM_DISABLED))
{
/* if the WF driver has activated PS-Poll */
if (g_psPollActive == true)
{
/* wake up MRF24W */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
// will need to put device back into PS-Poll sleep mode after transaction
SetSleepNeeded();
#if defined(TCPIP_STACK_USE_EVENT_NOTIFICATION)
WifiAsyncSetEventPending(ASYNC_POWER_SAVE_PENDING); // wake up power save task
#endif
}
}
/*******************************************************************************
Function:
void WF_PsPollEnable(BOOL rxDtim)
Summary:
Enables PS Poll mode.
Description:
Enables PS Poll mode. PS-Poll (Power-Save Poll) is a mode allowing for
longer battery life. The MRF24WB0M coordinates with the Access Point to go
to sleep and wake up at periodic intervals to check for data messages, which
the Access Point will buffer. The listenInterval in the Connection
Algorithm defines the sleep interval. By default, PS-Poll mode is disabled.
When PS Poll is enabled, the WF Host Driver will automatically force the
MRF24WB0M to wake up each time the Host sends Tx data or a control message
to the MRF24WB0M. When the Host message transaction is complete the
MRF24WB0M driver will automatically re-enable PS Poll mode.
When the application is likely to experience a high volume of data traffic
then PS-Poll mode should be disabled for two reasons:
1. No power savings will be realized in the presence of heavy data traffic.
2. Performance will be impacted adversely as the WiFi Host Driver
continually activates and deactivates PS-Poll mode via SPI messages.
Precondition:
MACInit must be called first.
Parameters:
rxDtim -- TRUE if MRF24WB0M should wake up periodically and check for
buffered broadcast messages, else FALSE
Returns:
None.
Remarks:
None.
*****************************************************************************/
void WF_PsPollEnable(BOOL rxDtim)
{
tWFPwrModeReq pwrModeReq;
/* fill in request structure and send message to MRF24WB0M */
pwrModeReq.mode = PS_POLL_ENABLED;
pwrModeReq.wake = 0;
pwrModeReq.rcvDtims = rxDtim;
SendPowerModeMsg(&pwrModeReq);
if (rxDtim == TRUE)
{
SetPowerSaveState(WF_PS_PS_POLL_DTIM_ENABLED);
}
else
{
SetPowerSaveState(WF_PS_PS_POLL_DTIM_DISABLED);
}
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
}
/*******************************************************************************
Function:
void WF_PsPollEnable(BOOL rxDtim, BOOL aggressive)
Summary:
Enables PS Poll mode.
Description:
Enables PS Poll mode. PS-Poll (Power-Save Poll) is a mode allowing for
longer battery life. The MRF24W coordinates with the Access Point to go
to sleep and wake up at periodic intervals to check for data messages, which
the Access Point will buffer. The listenInterval in the Connection
Algorithm defines the sleep interval. By default, PS-Poll mode is disabled.
When PS Poll is enabled, the WF Host Driver will automatically force the
MRF24W to wake up each time the Host sends Tx data or a control message
to the MRF24W. When the Host message transaction is complete the
MRF24W driver will automatically re-enable PS Poll mode.
When the application is likely to experience a high volume of data traffic
then PS-Poll mode should be disabled for two reasons:
1. No power savings will be realized in the presence of heavy data traffic.
2. Performance will be impacted adversely as the WiFi Host Driver
continually activates and deactivates PS-Poll mode via SPI messages.
Precondition:
MACInit must be called first.
Parameters:
rxDtim - TRUE listens at the DTIM interval and FALSE listens at the CASetListenInterval
Returns:
None.
Remarks:
None.
*****************************************************************************/
void WF_PsPollEnable(BOOL rxDtim)
{
#if defined(__18CXX)
static tWFPwrModeReq pwrModeReq;
#else
tWFPwrModeReq pwrModeReq;
#endif
// if not currently connected
#if !defined(MRF24WG)
if (gRFModuleVer1209orLater && !WFisConnected())
#else
if (!WFisConnected())
#endif
{
// save caller parameters for later, when we can enable this mode
g_rxDtim = rxDtim;
SetAppPowerSaveMode(TRUE);
return;
}
/* fill in request structure and send message to MRF24W */
pwrModeReq.mode = PS_POLL_ENABLED;
pwrModeReq.wake = 0;
pwrModeReq.rcvDtims = rxDtim;
SendPowerModeMsg(&pwrModeReq);
if (rxDtim == TRUE)
{
SetPowerSaveState(WF_PS_PS_POLL_DTIM_ENABLED);
}
else
{
SetPowerSaveState(WF_PS_PS_POLL_DTIM_DISABLED);
}
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
SetAppPowerSaveMode(TRUE);
}
/*****************************************************************************
* FUNCTION: WFHardwareInit
*
* RETURNS: error code
*
* PARAMS: None
*
* NOTES: Initializes CPU Host hardware interfaces (SPI, External Interrupt).
* Also resets the MRF24WB0M.
*****************************************************************************/
void WFHardwareInit(void)
{
g_MgmtReadMsgReady = FALSE;
g_ExIntNeedsServicing = FALSE;
RawMoveState.rawInterrupt = 0;
RawMoveState.waitingForRawMoveCompleteInterrupt = FALSE; /* not waiting for RAW move complete */
/* initialize the SPI interface */
WF_SpiInit();
/* Reset the MRF24WB0M (using SPI bus to write/read MRF24WB0M registers */
ChipReset();
/* disable the interrupts gated by the 16-bit host int register */
HostInterrupt2RegInit(WF_HOST_2_INT_MASK_ALL_INT, WF_INT_DISABLE);
/* disable the interrupts gated the by main 8-bit host int register */
HostInterruptRegInit(WF_HOST_INT_MASK_ALL_INT, WF_INT_DISABLE);
/* Initialize the External Interrupt for the MRF24WB0M allowing the MRF24WB0M to interrupt
* the Host from this point forward. */
WF_EintInit();
WF_EintEnable();
/* enable the following MRF24WB0M interrupts */
HostInterruptRegInit((WF_HOST_INT_MASK_FIFO_1_THRESHOLD | /* Mgmt Rx Msg interrupt */
WF_HOST_INT_MASK_FIFO_0_THRESHOLD | /* Data Rx Msg interrupt */
WF_HOST_INT_MASK_RAW_0_INT_0 | /* RAW0 Move Complete interrupt */
WF_HOST_INT_MASK_RAW_1_INT_0), /* RAW1 Move Complete interrupt */
WF_INT_ENABLE);
/* Disable PS-Poll mode */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}
/*******************************************************************************
Function:
void DRV_WIFI_PsPollEnable(DRV_WIFI_PS_POLL_CONTEXT *p_context);
Summary:
Enables PS Poll mode.
Description:
Enables PS Poll mode. PS-Poll (Power-Save Poll) is a mode allowing for
longer battery life. The MRF24W coordinates with the Access Point to go
to sleep and wake up at periodic intervals to check for data messages, which
the Access Point will buffer. The listenInterval in the Connection
Algorithm defines the sleep interval. By default, PS-Poll mode is disabled.
When PS Poll is enabled, the WF Host Driver will automatically force the
MRF24W to wake up each time the Host sends Tx data or a control message
to the MRF24W. When the Host message transaction is complete the
MRF24W driver will automatically re-enable PS Poll mode.
When the application is likely to experience a high volume of data traffic
then PS-Poll mode should be disabled for two reasons:
1. No power savings will be realized in the presence of heavy data traffic.
2. Performance will be impacted adversely as the WiFi Host Driver
continually activates and deactivates PS-Poll mode via SPI messages.
Parameters:
p_context - Pointer to ps poll context. See DRV_WIFI_PS_POLL_CONTEXT
structure.
Returns:
None.
Remarks:
None.
*****************************************************************************/
void DRV_WIFI_PsPollEnable(DRV_WIFI_PS_POLL_CONTEXT *p_context)
{
t_wfPwrModeReq pwrModeReq;
// if not currently connected
if (!WFisConnected())
{
// save caller parameters for later, when we can enable this mode
g_savedPsPollContext.listenInterval = p_context->listenInterval;
g_savedPsPollContext.dtimInterval = p_context->dtimInterval;
g_savedPsPollContext.useDtim = p_context->useDtim;
SetAppPowerSaveMode(true);
return;
}
SetListenInterval(p_context->listenInterval);
SetDtimInterval(p_context->dtimInterval);
// fill in request structure and send message to MRF24WG
pwrModeReq.mode = PS_POLL_ENABLED;
pwrModeReq.wake = 0;
pwrModeReq.rcvDtims = p_context->useDtim;
SendPowerModeMsg(&pwrModeReq);
if (p_context->useDtim)
{
SetPowerSaveState(DRV_WIFI_PS_PS_POLL_DTIM_ENABLED);
}
else
{
SetPowerSaveState(DRV_WIFI_PS_PS_POLL_DTIM_DISABLED);
}
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_ON);
SetAppPowerSaveMode(true);
}
/*****************************************************************************
* FUNCTION: WFHardwareInit
*
* RETURNS: error code
*
* PARAMS: None
*
* NOTES: Initializes CPU Host hardware interfaces (SPI, External Interrupt).
* Also resets the MRF24W.
*****************************************************************************/
void WFHardwareInit(void)
{
UINT8 mask8;
UINT16 mask16;
g_MgmtReadMsgReady = FALSE;
g_ExIntNeedsServicing = FALSE;
RawMoveState.rawInterrupt = 0;
RawMoveState.waitingForRawMoveCompleteInterrupt = FALSE; /* not waiting for RAW move complete */
/* initialize the SPI interface */
WF_SpiInit();
#if defined(__Digilent_Build__)
WF_SetRST_N(WF_LOW); // put module into reset; should already be there.
// we have taken out the next 3 lines as MarkW says we do not need to toggle HIB to competely reset the part.
// WF_SetCE_N(WF_HIGH); // disable module, turn off regulators
// DelayMs(200); // 200ms to allow decoupling caps to discharge, between the 70uF in the MRF , this can take some time.
// WF_SetCE_N(WF_LOW); // enable module, turn on regulators; careful this has an inrush that can drag the Power supply below min. if the MRF is not decoupled well enough.
DelayMs(2); // Spec says at least 1ms to let the regulators settle, leave this here to ensure timing from board powerup.
WF_SetRST_N(WF_HIGH); // take module out of of reset
DelayMs(5); // Per MarkW’s email, leave 5ms here before accessing the SPI port
#else
/* Toggle the module into and then out of hibernate */
WF_SetCE_N(WF_HIGH); /* disable module */
WF_SetCE_N(WF_LOW); /* enable module */
/* Toggle the module into and out of reset */
WF_SetRST_N(WF_LOW); // put module into reset
WF_SetRST_N(WF_HIGH); // take module out of of reset
#endif
/* Silicon work-around -- needed for A1 silicon to initialize PLL values correctly */
ResetPll();
/* Soft reset the MRF24W (using SPI bus to write/read MRF24W registers */
ChipReset();
/* disable the interrupts gated by the 16-bit host int register */
HostInterrupt2RegInit(WF_HOST_2_INT_MASK_ALL_INT, (UINT16)WF_INT_DISABLE);
/* disable the interrupts gated the by main 8-bit host int register */
HostInterruptRegInit(WF_HOST_INT_MASK_ALL_INT, WF_INT_DISABLE);
/* Initialize the External Interrupt for the MRF24W allowing the MRF24W to interrupt */
/* the Host from this point forward. */
WF_EintInit();
WF_EintEnable();
/* enable the following MRF24W interrupts in the INT1 8-bit register */
mask8 = (WF_HOST_INT_MASK_FIFO_1_THRESHOLD | /* Mgmt Rx Msg interrupt */
WF_HOST_INT_MASK_FIFO_0_THRESHOLD | /* Data Rx Msg interrupt */
WF_HOST_INT_MASK_RAW_0_INT_0 | /* RAW0 Move Complete (Data Rx) interrupt */
WF_HOST_INT_MASK_RAW_1_INT_0 | /* RAW1 Move Complete (Data Tx) interrupt */
WF_HOST_INT_MASK_INT2); /* Interrupt 2 interrupt */
HostInterruptRegInit(mask8, WF_INT_ENABLE);
/* enable the following MRF24W interrupts in the INT2 16-bit register */
mask16 = (WF_HOST_INT_MASK_RAW_2_INT_0 | /* RAW2 Move Complete (Mgmt Rx) interrupt */
WF_HOST_INT_MASK_RAW_3_INT_0 | /* RAW3 Move Complete (Mgmt Tx) interrupt */
WF_HOST_INT_MASK_RAW_4_INT_0 | /* RAW4 Move Complete (Scratch) interrupt */
WF_HOST_INT_MASK_RAW_5_INT_0 | /* RAW5 Move Complete (Scratch) interrupt */
WF_HOST_INT_MASK_MAIL_BOX_0_WRT);
HostInterrupt2RegInit(mask16, WF_INT_ENABLE);
/* Disable PS-Poll mode */
WFConfigureLowPowerMode(WF_LOW_POWER_MODE_OFF);
}