ath9k_htc/target_firmware/magpie_fw_dev/target/inc/k2/hif_usb.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: mbox_hw.h
  37  *
  38  * @Abstract: mailbox hardware definitions
  39  *
  40  * @Notes:
  41  */
  42
  43 #ifndef __HIF_USB_H__
  44 #define __HIF_USB_H__
  45
  46 #include <sys_cfg.h>
  47 #include <vdesc_api.h>
  48 //#include <desc.h>
  49 #include <dma_engine_api.h>
  50
  51 #define HIF_USB_PIPE_TX             1
  52 #define HIF_USB_PIPE_RX             2
  53 #define HIF_USB_PIPE_INTERRUPT      3
  54 #define HIF_USB_PIPE_COMMAND        4
  55 #define HIF_USB_PIPE_HP_TX          5
  56 #define HIF_USB_PIPE_MP_TX          6
  57
  58 struct VBUF_QUEUE
  59 {
  60     VBUF *head;
  61     VBUF *tail;
  62 };
  63
  64     /* the mailbox hardware layer context */
  65 typedef struct _HIF_USB_CONTEXT {
  66     HIF_CALLBACK                hifCb;
  67     struct zsDmaQueue           dnQ;
  68     struct zsTxDmaQueue         upQ;
  69 #if SYSTEM_MODULE_HP_EP5
  70     struct zsDmaQueue           hpdnQ;  // high priority
  71 #endif
  72 #if SYSTEM_MODULE_HP_EP6
  73     struct zsDmaQueue           mpdnQ;  // medium priority
  74 #endif
  75     //struct VBUF_QUEUE           upVbufQ;
  76     VBUF                                *cmdQueue;
  77     struct VBUF_QUEUE           eventBufQ;
  78
  79     // Left a door for extension the structure
  80     void *pReserved;
  81 } HIF_USB_CONTEXT;
  82
  83
  84 #endif