ath9k_htc/target_firmware/magpie_fw_dev/target/inc/usbfifo_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 /*
  36  * @File: HIF_api.h
  37  *
  38  * @Abstract: Host Interface api
  39  *
  40  * @Notes:
  41  */
  42
  43 #ifndef _USB_FIFO_API_H
  44 #define _USB_FIFO_API_H
  45
  46 #include "vbuf_api.h"
  47
  48 typedef struct _USB_FIFO_CONFIG {
  49         /* callback to get the buf for receiving commands from USB FIFO */
  50     VBUF* (*get_command_buf)(void);
  51         /* callback when receiving a command */
  52     void (*recv_command)(VBUF *cmd);
  53         /* callback to get the buf for event to send to the host */
  54     VBUF* (*get_event_buf)(void);
  55         /* callback to indicate the event has been sent to the host */
  56     void (*send_event_done)(VBUF *buf);
  57
  58         /* context used for all callbacks */
  59     //void *context;
  60 } USB_FIFO_CONFIG;
  61
  62 /* hardware API table structure (API descriptions below) */
  63 struct usbfifo_api {
  64     void (*_init)(USB_FIFO_CONFIG *pConfig);
  65     void (*_enable_event_isr)(void);
  66
  67         /* room to expand this table by another table */
  68     void *pReserved;
  69 };
  70
  71 extern void usbfifo_module_install(struct usbfifo_api *apis);
  72
  73 #endif /* #ifndef _USB_FIFO_API_H */