/******************************************************************************
* Function: void USBCtrlTrfInHandler(void)
*
* PreCondition: None
*
* Input: None
*
* Output: None
*
* Side Effects: None
*
* Overview: This routine handles an IN transaction according to
* which control transfer state is currently active.
*
*
* Note: A Set Address Request must not change the acutal address
* of the device until the completion of the control
* transfer. The end of the control transfer for Set Address
* Request is an IN transaction. Therefore it is necessary
* to service this unique situation when the condition is
* right. Macro mUSBCheckAdrPendingState is defined in
* usb9.h and its function is to specifically service this
* event.
*****************************************************************************/
void USBCtrlTrfInHandler(void)
{
mUSBCheckAdrPendingState(); // Must check if in ADR_PENDING_STATE
if(ctrl_trf_state == CTRL_TRF_TX)
{
USBCtrlTrfTxService();
if(ep0Bi.Stat.DTS == 0)
ep0Bi.Stat._byte = _USIE|_DAT1|_DTSEN;
else
ep0Bi.Stat._byte = _USIE|_DAT0|_DTSEN;
}
else // CTRL_TRF_RX
USBPrepareForNextSetupTrf();
}//end USBCtrlTrfInHandler
/******************************************************************************
* Function: void USBCtrlTrfInHandler(void)
*
* PreCondition: None
*
* Input: None
*
* Output: None
*
* Side Effects: None
*
* Overview: This routine handles an IN transaction according to
* which control transfer state is currently active.
*
*
* Note: A Set Address Request must not change the acutal address
* of the device until the completion of the control
* transfer. The end of the control transfer for Set Address
* Request is an IN transaction. Therefore it is necessary
* to service this unique situation when the condition is
* right. Macro mUSBCheckAdrPendingState is defined in
* usb9.h and its function is to specifically service this
* event.
*****************************************************************************/
void USBCtrlTrfInHandler(void)
{
CTRL_TRF_SETUP xxx;
xxx.bAltID = 1;
mUSBCheckAdrPendingState(); // Must check if in ADR_PENDING_STATE
if(ctrl_trf_state == CTRL_TRF_TX)
{
USBCtrlTrfTxService();
/********************************************************************
Bug Fix: May 14, 2007 (#F7 - Partial 2/4)
*********************************************************************
For a control transfer read, if the host tries to read more data
than what it has requested, the peripheral device should stall the
extra IN transactions and the status stage. Typically, a host does
not try to read more data than what it has requested. The original
firmware did not handle this situation. Instead of stalling extra
IN transactions, the device kept sending out zero length packets.
This work around checks if a short IN packet has been sent or not.
If it has, the IN endpoint will be set to install the next IN token.
If not, then the original endpoint setup code will be executed.
********************************************************************/
if(short_pkt_status == SHORT_PKT_SENT)
{
// If a short packet has been sent, don't want to send any more,
// stall next time if host is still trying to read.
ep0Bi.Stat._byte = _USIE|_BSTALL;
}
/*******************************************************************/
else
{
if(ep0Bi.Stat.DTS == 0)
ep0Bi.Stat._byte = _USIE|_DAT1|_DTSEN;
else
ep0Bi.Stat._byte = _USIE|_DAT0|_DTSEN;
}//end if(...)else
}
else // CTRL_TRF_RX
USBPrepareForNextSetupTrf();
}//end USBCtrlTrfInHandler
/******************************************************************************
* Function: void USBCtrlEPServiceComplete(void)
*
* PreCondition: None
*
* Input: None
*
* Output: None
*
* Side Effects: None
*
* Overview: This routine wrap up the ramaining tasks in servicing
* a Setup Request. Its main task is to set the endpoint
* controls appropriately for a given situation. See code
* below.
* There are three main scenarios:
* a) There was no handler for the Request, in this case
* a STALL should be sent out.
* b) The host has requested a read control transfer,
* endpoints are required to be setup in a specific way.
* c) The host has requested a write control transfer, or
* a control data stage is not required, endpoints are
* required to be setup in a specific way.
*
* Packet processing is resumed by clearing PKTDIS bit.
*
* Note: None
*****************************************************************************/
void USBCtrlEPServiceComplete(void)
{
/********************************************************************
Bug Fix: May 14, 2007 (#AF1)
*********************************************************************
See silicon errata for 4550 A3. Now clearing PKTDIS before re-arming
any EP0 endpoints.
********************************************************************/
/*
* PKTDIS bit is set when a Setup Transaction is received.
* Clear to resume packet processing.
*/
UCONbits.PKTDIS = 0;
/*******************************************************************/
if(ctrl_trf_session_owner == MUID_NULL)
{
/*
* If no one knows how to service this request then stall.
* Must also prepare EP0 to receive the next SETUP transaction.
*/
ep0Bo.Cnt = EP0_BUFF_SIZE;
ep0Bo.ADR = (byte*)&SetupPkt;
ep0Bo.Stat._byte = _USIE|_BSTALL;
ep0Bi.Stat._byte = _USIE|_BSTALL;
}
else // A module has claimed ownership of the control transfer session.
{
if(SetupPkt.DataDir == DEV_TO_HOST)
{
if(SetupPkt.wLength < wCount._word)
wCount._word = SetupPkt.wLength;
USBCtrlTrfTxService();
ctrl_trf_state = CTRL_TRF_TX;
/*
* Control Read:
* <SETUP[0]><IN[1]><IN[0]>...<OUT[1]> | <SETUP[0]>
* 1. Prepare OUT EP to respond to early termination
*
* NOTE:
* If something went wrong during the control transfer,
* the last status stage may not be sent by the host.
* When this happens, two different things could happen
* depending on the host.
* a) The host could send out a RESET.
* b) The host could send out a new SETUP transaction
* without sending a RESET first.
* To properly handle case (b), the OUT EP must be setup
* to receive either a zero length OUT transaction, or a
* new SETUP transaction.
*
* Since the SETUP transaction requires the DTS bit to be
* DAT0 while the zero length OUT status requires the DTS
* bit to be DAT1, the DTS bit check by the hardware should
* be disabled. This way the SIE could accept either of
* the two transactions.
*
* Furthermore, the Cnt byte should be set to prepare for
* the SETUP data (8-byte or more), and the buffer address
* should be pointed to SetupPkt.
*/
ep0Bo.Cnt = EP0_BUFF_SIZE;
ep0Bo.ADR = (byte*)&SetupPkt;
ep0Bo.Stat._byte = _USIE; // Note: DTSEN is 0!
/*
* 2. Prepare IN EP to transfer data, Cnt should have
* been initialized by responsible request owner.
*/
ep0Bi.ADR = (byte*)&CtrlTrfData;
ep0Bi.Stat._byte = _USIE|_DAT1|_DTSEN;
}
else // (SetupPkt.DataDir == HOST_TO_DEV)
{
ctrl_trf_state = CTRL_TRF_RX;
/*
* Control Write:
* <SETUP[0]><OUT[1]><OUT[0]>...<IN[1]> | <SETUP[0]>
*
* 1. Prepare IN EP to respond to early termination
*
* This is the same as a Zero Length Packet Response
* for control transfer without a data stage
*/
ep0Bi.Cnt = 0;
ep0Bi.Stat._byte = _USIE|_DAT1|_DTSEN;
/*
* 2. Prepare OUT EP to receive data.
*/
ep0Bo.Cnt = EP0_BUFF_SIZE;
ep0Bo.ADR = (byte*)&CtrlTrfData;
ep0Bo.Stat._byte = _USIE|_DAT1|_DTSEN;
}//end if(SetupPkt.DataDir == DEV_TO_HOST)
}//end if(ctrl_trf_session_owner == MUID_NULL)
}//end USBCtrlEPServiceComplete