xref: /freebsd/sys/dev/ocs_fc/ocs_hw_queues.h (revision 1d386b48a555f61cb7325543adbbb5c3f3407a66)
1 /*-
2  * Copyright (c) 2017 Broadcom. All rights reserved.
3  * The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  *    this list of conditions and the following disclaimer in the documentation
13  *    and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /**
33  * @file
34  *
35  */
36 
37 #ifndef __OCS_HW_QUEUES_H__
38 #define __OCS_HW_QUEUES_H__
39 
40 #define OCS_HW_MQ_DEPTH	128
41 
42 typedef enum {
43 	QTOP_EQ = 0,
44 	QTOP_CQ,
45 	QTOP_WQ,
46 	QTOP_RQ,
47 	QTOP_MQ,
48 	QTOP_LAST,
49 } ocs_hw_qtop_entry_e;
50 
51 typedef struct {
52 	ocs_hw_qtop_entry_e entry;
53 	uint8_t set_default;
54 	uint32_t len;
55 	uint8_t class;
56 	uint8_t ulp;
57 	uint8_t filter_mask;
58 } ocs_hw_qtop_entry_t;
59 
60 typedef struct {
61 	struct rq_config {
62 		hw_eq_t *eq;
63 		uint32_t len;
64 		uint8_t class;
65 		uint8_t ulp;
66 		uint8_t filter_mask;
67 	} rq_cfg[16];
68 	uint32_t num_pairs;
69 } ocs_hw_mrq_t;
70 
71 #define MAX_TOKENS			256
72 #define OCS_HW_MAX_QTOP_ENTRIES	200
73 
74 typedef struct {
75 	ocs_os_handle_t os;
76 	ocs_hw_qtop_entry_t *entries;
77 	uint32_t alloc_count;
78 	uint32_t inuse_count;
79 	uint32_t entry_counts[QTOP_LAST];
80 	uint32_t rptcount[10];
81 	uint32_t rptcount_idx;
82 } ocs_hw_qtop_t;
83 
84 extern ocs_hw_qtop_t *ocs_hw_qtop_parse(ocs_hw_t *hw, const char *qtop_string);
85 extern void ocs_hw_qtop_free(ocs_hw_qtop_t *qtop);
86 extern const char *ocs_hw_qtop_entry_name(ocs_hw_qtop_entry_e entry);
87 extern uint32_t ocs_hw_qtop_eq_count(ocs_hw_t *hw);
88 
89 extern ocs_hw_rtn_e ocs_hw_init_queues(ocs_hw_t *hw, ocs_hw_qtop_t *qtop);
90 extern void hw_thread_eq_handler(ocs_hw_t *hw, hw_eq_t *eq, uint32_t max_isr_time_msec);
91 extern void hw_thread_cq_handler(ocs_hw_t *hw, hw_cq_t *cq);
92 extern  hw_wq_t *ocs_hw_queue_next_wq(ocs_hw_t *hw, ocs_hw_io_t *io);
93 
94 #endif /* __OCS_HW_QUEUES_H__ */
95