ath9k_htc/sboot/magpie_1_1/sboot/hif/inc/usb_api.h

   1 /*
   2  * Copyright (c) 2013 Qualcomm Atheros, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted (subject to the limitations in the
   7  * disclaimer below) provided that the following conditions are met:
   8  *
   9  *  * Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  *  * Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the
  15  *    distribution.
  16  *
  17  *  * Neither the name of Qualcomm Atheros nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific prior written permission.
  20  *
  21  * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  22  * GRANTED BY THIS LICENSE.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
  23  * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
  24  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  32  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  33  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 #ifndef USB_API_H
  36 #define USB_API_H
  37
  38 #include "dt_defs.h"
  39
  40 /******** hardware API table structure (API descriptions below) *************/
  41 struct usb_api {
  42     void (*_usb_init)(void);
  43     void (*_usb_rom_task)(void);
  44     void (*_usb_fw_task)(void);
  45     void (*_usb_init_phy)(void);
  46
  47     // ep0 operation
  48     void (*_usb_ep0_setup)(void);
  49
  50     void (*_usb_ep0_tx)(void);
  51     void (*_usb_ep0_rx)(void);
  52
  53     // get/set interface
  54     BOOLEAN (*_usb_get_interface)(void);
  55     BOOLEAN (*_usb_set_interface)(void);
  56
  57     // get/set configuration
  58     BOOLEAN (*_usb_get_configuration)(void);
  59     BOOLEAN (*_usb_set_configuration)(void);
  60
  61     // standard/vendor command
  62     BOOLEAN (*_usb_standard_cmd)(void);
  63     void (*_usb_vendor_cmd)(void);
  64
  65     void (*_usb_power_off)(void);
  66     void (*_usb_reset_fifo)(void);
  67     void (*_usb_gen_wdt)(void);
  68     void (*_usb_jump_boot)(void);
  69
  70     BOOLEAN (*_usb_clr_feature)(void);
  71     BOOLEAN (*_usb_set_feature)(void);
  72     BOOLEAN (*_usb_set_address)(void);
  73     BOOLEAN (*_usb_get_descriptor)(void);
  74
  75     BOOLEAN (*_usb_get_status)(void);
  76     void (*_usb_setup_desc)(void);
  77     void (*_usb_reg_out)(void);
  78     void (*_usb_status_in)(void);
  79
  80     void (*_usb_ep0_tx_data)(void);
  81     void (*_usb_ep0_rx_data)(void);
  82
  83     void (*_usb_clk_init)(void);
  84 };
  85
  86 #endif