usbps
Vitis Drivers API Documentation
Functions
xusbps_ch9_audio.c File Reference

Overview

This file contains the implementation of chapter 9 specific code for the example. 

MODIFICATION HISTORY:
Ver   Who       Date     Changes






1.0  pm         20/02/20 First release
 



Functions


u32 XUsbPs_Ch9SetupDevDescReply (u8 *BufPtr, u32 BufLen)


 This function returns the device descriptor for the device.  More...


 


u32 XUsbPs_Ch9SetupCfgDescReply (u8 *BufPtr, u32 BufLen)


 This function returns the configuration descriptor for the device.  More...


 


u32 XUsbPs_Ch9SetupStrDescReply (u8 *BufPtr, u32 BufLen, u8 Index)


 This function returns a string descriptor for the given index.  More...


 


void XUsbPs_SetConfiguration (XUsbPs *InstancePtr, int ConfigIdx)


 Changes State of Core to USB configured State.  More...


 


void XUsbPs_SetConfigurationApp (XUsbPs *InstancePtr, XUsbPs_SetupData *SetupData)


 This function is called by Chapter9 handler when SET_CONFIGURATION command is received from Host.  More...


 


void XUsbPs_SetInterfaceHandler (XUsbPs *InstancePtr, XUsbPs_SetupData *SetupData)


 This function is called by Chapter9 handler when SET_CONFIGURATION command or SET_INTERFACE command is received from Host.  More...


 




Function Documentation






      

        

          u32 XUsbPs_Ch9SetupCfgDescReply 
          (
          u8 * 
          BufPtr, 
        

        

          
          
          u32 
          BufLen 
        

        

          
          )
          
        

      





This function returns the configuration descriptor for the device. 


Parameters

  

    
InstancePtris a pointer to the Usb_DevData instance. 

    
BufPtris the pointer to the buffer that is to be filled with the descriptor. 

    
BufLenis the size of the provided buffer.

  

  




Returns
Length of the descriptor in the buffer on success. 0 on error. 











      

        

          u32 XUsbPs_Ch9SetupDevDescReply 
          (
          u8 * 
          BufPtr, 
        

        

          
          
          u32 
          BufLen 
        

        

          
          )
          
        

      





This function returns the device descriptor for the device. 


Parameters

  

    
InstancePtris a pointer to the Usb_DevData instance. 

    
BufPtris pointer to the buffer that is to be filled with the descriptor. 

    
BufLenis the size of the provided buffer.

  

  




Returns
Length of the descriptor in the buffer on success. 0 on error. 











      

        

          u32 XUsbPs_Ch9SetupStrDescReply 
          (
          u8 * 
          BufPtr, 
        

        

          
          
          u32 
          BufLen, 
        

        

          
          
          u8 
          Index 
        

        

          
          )
          
        

      





This function returns a string descriptor for the given index. 


Parameters

  

    
InstancePtris a pointer to the Usb_DevData instance. 

    
BufPtris a pointer to the buffer that is to be filled with the descriptor. 

    
BufLenis the size of the provided buffer. 

    
Indexis the index of the string for which the descriptor is requested.

  

  




Returns
Length of the descriptor in the buffer on success. 0 on error. 











      

        

          void XUsbPs_SetConfiguration 
          (
          XUsbPs * 
          InstancePtr, 
        

        

          
          
          int 
          ConfigIdx 
        

        

          
          )
          
        

      





Changes State of Core to USB configured State. 


Parameters

  

    
InstancePtris a pointer to the Usb_DevData instance. 

    
Ctrlis a pointer to the Setup packet data.

  

  




Returns
XST_SUCCESS else XST_FAILURE


Note
None. 











      

        

          void XUsbPs_SetConfigurationApp 
          (
          XUsbPs * 
          InstancePtr, 
        

        

          
          
          XUsbPs_SetupData * 
          SetupData 
        

        

          
          )
          
        

      





This function is called by Chapter9 handler when SET_CONFIGURATION command is received from Host. 


Parameters

  

    
InstancePtris pointer to Usb_DevData instance. 

    
SetupDatais the setup packet received from Host.

  

  




Returns
    

  • XST_SUCCESS if successful,
    • 

  • XST_FAILURE if unsuccessful.
    • 





Note
Non control endpoints must be enabled after SET_CONFIGURATION command since hardware clears all previously enabled endpoints except control endpoints when this command is received. 











      

        

          void XUsbPs_SetInterfaceHandler 
          (
          XUsbPs * 
          InstancePtr, 
        

        

          
          
          XUsbPs_SetupData * 
          SetupData 
        

        

          
          )
          
        

      





This function is called by Chapter9 handler when SET_CONFIGURATION command or SET_INTERFACE command is received from Host. 


Parameters

  

    
InstancePtris pointer to Usb_DevData instance. 

    
SetupDatais the setup packet received from Host.

  

  




Note
Non control endpoints must be enabled after SET_INTERFACE command since hardware clears all previously enabled endpoints except control endpoints when this command is received.