usbhalos.h

一个Linux下的软猫驱动

********************************************************************************/
__shimcall__
HANDLE OsUsbGetTxRequest				(HANDLE hUsbOsHal);

__shimcall__
VOID OsUsbReturnUnusedRequest (HANDLE hRequest);

/********************************************************************************

Name:           OsUsbMakeNotifyRequest

Description:    Schedules device-to-host interrupt request on pipe 2 (notification).
				
Arguments:      hUsbOsHal	- bottom HAL handle

Return Value:   result of the call

Notes:			This function can be called on high CPU priority level and must return
				immediately and must not wait on any synchronization object.

********************************************************************************/
__shimcall__
BOOL OsUsbMakeNotifyRequest				(HANDLE hUsbOsHal);

/********************************************************************************

Name:           OsUsbMakeDataTransmitRequest

Description:    Schedules host-to-device bulk request on pipe 1 (data).
				
Arguments:      hUsbOsHal	- bottom HAL handle
				hRequest	- handle to an OS specific data structure needed to 
							  initiate a bulk request. This handle is returned by
							  OsUsbGetTxRequest() call
				pBuf		- points to data to be transmitted
				nBytes		- size of data to be transmitted

Return Value:   result of the call

Notes:			This function can be called on high CPU priority level and must return
				immediately and must not wait on any synchronization object.

********************************************************************************/
__shimcall__
BOOL OsUsbMakeDataTransmitRequest		(HANDLE hUsbOsHal, HANDLE hRequest, PVOID pBuf, UINT32 nBytes);

/********************************************************************************

Name:           OsUsbMakeDataReceiveRequest

Description:    Schedules device-to-host bulk request on pipe 1 (data).
				
Arguments:      hUsbOsHal	- bottom HAL handle
				pBuf		- points to a buffer to store received data
				nBytes		- size of data to receive

Return Value:   result of the call

Notes:			This function can be called on high CPU priority level and must return
				immediately and must not wait on any synchronization object.

********************************************************************************/
__shimcall__
BOOL OsUsbMakeDataReceiveRequest		(HANDLE hUsbOsHal, PVOID pBuf, UINT32 nBytes);

#if TARGET_HCF_FAMILY
/********************************************************************************

Name:           OsUsbMakeDownloadTransmitRequest

Description:    Schedules host-to-device bulk request on pipe 3 (DSP download).
				
Arguments:      hUsbOsHal	- bottom HAL handle
				pBuf		- points to data to be transmitted
				nBytes		- size of data to be transmitted

Return Value:   result of the call

Notes:			This function can be called on high CPU priority level and must return
				immediately and must not wait on any synchronization object.

********************************************************************************/
__shimcall__
BOOL OsUsbMakeDownloadTransmitRequest	(HANDLE pUsbOsHal, PVOID pBuf, UINT32 nBytes);
#endif

//#$YS$
/********************************************************************************

Name:           OsUsbResetPort

Description:    Reset USB port.
				
Arguments:      hUsbOsHal	- bottom HAL handle.

Return Value:   None

********************************************************************************/
__shimcall__
void OsUsbResetPort(HANDLE hUsbOsHal);


#ifdef USE_DCP
/********************************************************************************

Name:           OsUsbMakeDcpRequest

Description:    Schedules device-to-host bulk request on pipe 3 (DCP).
				
Arguments:      hUsbOsHal	- bottom HAL handle
				pBuf		- buffer to read samples to
				nBytes		- size of such buffer

Return Value:   none

Notes:			After USB completion routine is called, bottom HAL reschedules USB
				bulk request on pipe 3 without top HAL intervention until 
				OsUsbCancelDcpRequests() is called.

********************************************************************************/
__shimcall__
BOOL OsUsbMakeDcpRequest				(HANDLE hUsbOsHal, PVOID pBuf, UINT32 nBytes);
__shimcall__
void OsUsbStartDcpRequests				(HANDLE hUsb, HANDLE hDcp);

/********************************************************************************

Name:           OsUsbCancelDcpRequests

Description:    Stops scheduling bulk read requests on DCP pipe.
				
Arguments:      hUsbOsHal	- bottom HAL handle

Return Value:   none

Notes:			

********************************************************************************/
__shimcall__
void OsUsbCancelDcpRequests				(HANDLE hUsbOsHal);
#endif

/********************************************************************************

Name:           OsUsbResetPipes

Description:    Aborts any transactions-in-progress across USB
				
Arguments:      hUsbOsHal	- bottom HAL handle

Return Value:   none

Notes:			

********************************************************************************/
__shimcall__
void OsUsbResetPipes					(HANDLE hUsbOsHal);

/********************************************************************************
 The callback functions below are called from USB completion routines. 
 We need to be careful not to do any extensive processing in these functions
 *******************************************************************************/
/********************************************************************************

Name:           UsbHalNotificationReceived

Description:    Informs top HAL that host has completed read transaction on 
				notification pipe
				
Arguments:      hUpper			- top HAL handle
				pDataReceived	- pointer to received data
				RecvLength		- size of received data

Return Value:   needed for top HAL internal processing, should be ignored

Notes:			

********************************************************************************/
__shimcall__
BOOL UsbHalNotificationReceived (PVOID hUpper, PUINT8 pDataReceived, unsigned RecvLength);

/********************************************************************************

Name:           UsbHalDataReceived

Description:    Informs top HAL that host has completed read transaction on 
				data pipe
				
Arguments:      hUpper			- top HAL handle
				pDataReceived	- pointer to received data
				RecvLength		- size of received data

Return Value:   none

Notes:			

********************************************************************************/
__shimcall__
void UsbHalDataReceived			(PVOID hUpper, PUINT8 pDataReceived, unsigned RecvLength);

/********************************************************************************

Name:           UsbHalDataTransmitDone

Description:    Informs top HAL that host has completed write transaction on 
				data pipe
				
Arguments:      hUpper			- top HAL handle

Return Value:   none

Notes:			

********************************************************************************/
__shimcall__
void UsbHalDataTransmitDone		(PVOID hUpper, unsigned TxLength);

/********************************************************************************

Name:           UsbHalDataTransmitDone

Description:    Informs top HAL that host has completed write transaction on 
				control pipe
				
Arguments:      hUpper		- top HAL handle
				Request		- bRequest field of completed transaction
				value		- wValue field of completed transaction
				index		- wIndex field of completed transaction

Return Value:   none

Notes:			

********************************************************************************/
__shimcall__
void UsbHalControlTransferDone	(PVOID hUpper, PVOID userContext, UINT8 Request, UINT16 value, UINT16 index);

#if TARGET_HCF_FAMILY
/********************************************************************************

Name:           UsbHalDataTransmitDone

Description:    Informs top HAL that host has completed write transaction on 
				DSP download pipe
				
Arguments:      hUpper			- top HAL handle

Return Value:   none

Notes:			

********************************************************************************/
__shimcall__
void UsbHalDownloadTransmitDone (PVOID hUpper);
#endif


// HSF specific control request types (bRequest)
typedef enum		
{
	CD2_GET_INFROMATION,
	CD2_UPLOAD_FIRMWARE,
	CD2_CONTROL_SCRIPT,
	CD2_READ_EEPROM,
	CD2_WRITE_EEPROM,
	CD2_RESET,
	CD2_WAKEONRING
} CD2REQUESTTYPE;

#pragma pack (1)
typedef struct
{
	UINT8	bmRequestType;
	UINT8	bRequest;
	UINT16	wValue;
	UINT16	wIndex;
	UINT16	wLength;
	PVOID   pData;
} USB_REQUEST_HEADER, *PUSB_REQUEST_HEADER;
#pragma pack ()

#define MAX_NOTIFY_PACKET	64

#ifdef __cplusplus
}
#endif

#endif /* __USBHALOS_H */