ath9k_htc/target_firmware/magpie_fw_dev/target/inc/hif_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 _HIF_API_H
  44 #define _HIF_API_H
  45
  46 #include <adf_nbuf.h>
  47
  48 /* mailbox hw module configuration structure */
  49 typedef struct _HIF_CONFIG {
  50     int dummy;
  51 } HIF_CONFIG;
  52
  53 typedef struct _HIF_CALLBACK {
  54     /* callback when a buffer has be sent to the host*/
  55     void (*send_buf_done)(adf_nbuf_t buf, void *context);
  56     /* callback when a receive message is received */
  57     void (*recv_buf)(adf_nbuf_t hdr_buf, adf_nbuf_t buf, void *context);
  58     /* context used for all callbacks */
  59     void *context;
  60 } HIF_CALLBACK;
  61
  62 typedef void* hif_handle_t;
  63
  64 /* hardware API table structure (API descriptions below) */
  65 struct hif_api {
  66     hif_handle_t (*_init)(HIF_CONFIG *pConfig);
  67
  68     void (* _shutdown)(hif_handle_t);
  69
  70     void (*_register_callback)(hif_handle_t, HIF_CALLBACK *);
  71
  72     int  (*_get_total_credit_count)(hif_handle_t);
  73
  74     void (*_start)(hif_handle_t);
  75
  76     void (*_config_pipe)(hif_handle_t handle, int pipe, int creditCount);
  77
  78     int  (*_send_buffer)(hif_handle_t handle, int pipe, adf_nbuf_t buf);
  79
  80     void (*_return_recv_buf)(hif_handle_t handle, int pipe, adf_nbuf_t buf);
  81     //void (*_set_recv_bufsz)(int pipe, int bufsz);
  82     //void (*_pause_recv)(int pipe);
  83     //void (*_resume_recv)(int pipe);
  84     int  (*_is_pipe_supported)(hif_handle_t handle, int pipe);
  85
  86     int  (*_get_max_msg_len)(hif_handle_t handle, int pipe);
  87
  88     int  (*_get_reserved_headroom)(hif_handle_t handle);
  89
  90     void (*_isr_handler)(hif_handle_t handle);
  91
  92     void (*_get_default_pipe)(hif_handle_t handle, A_UINT8 *pipe_uplink, A_UINT8 *pipe_downlink);
  93
  94         /* room to expand this table by another table */
  95     void *pReserved;
  96 };
  97
  98 extern void hif_module_install(struct hif_api *apis);
  99 extern void generic_hif_module_install(struct hif_api *apis);
 100
 101 #endif /* #ifndef _HIF_API_H */