2 * Copyright (c) 2013 Qualcomm Atheros, Inc.
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:
9 * * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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
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.
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.
38 * @Abstract: Host Interface api
48 /* mailbox hw module configuration structure */
49 typedef struct _HIF_CONFIG {
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 */
62 typedef void* hif_handle_t;
64 /* hardware API table structure (API descriptions below) */
66 hif_handle_t (*_init)(HIF_CONFIG *pConfig);
68 void (* _shutdown)(hif_handle_t);
70 void (*_register_callback)(hif_handle_t, HIF_CALLBACK *);
72 int (*_get_total_credit_count)(hif_handle_t);
74 void (*_start)(hif_handle_t);
76 void (*_config_pipe)(hif_handle_t handle, int pipe, int creditCount);
78 int (*_send_buffer)(hif_handle_t handle, int pipe, adf_nbuf_t buf);
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);
86 int (*_get_max_msg_len)(hif_handle_t handle, int pipe);
88 int (*_get_reserved_headroom)(hif_handle_t handle);
90 void (*_isr_handler)(hif_handle_t handle);
92 void (*_get_default_pipe)(hif_handle_t handle, A_UINT8 *pipe_uplink, A_UINT8 *pipe_downlink);
94 /* room to expand this table by another table */
98 extern void generic_hif_module_install(struct hif_api *apis);
100 #endif /* #ifndef _HIF_API_H */