sys/dev/ocs_fc/ocs_hw_queues.h

   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  * $FreeBSD$
  32  */
  33
  34 /**
  35  * @file
  36  *
  37  */
  38
  39 #ifndef __OCS_HW_QUEUES_H__
  40 #define __OCS_HW_QUEUES_H__
  41
  42 #define OCS_HW_MQ_DEPTH 128
  43
  44 typedef enum {
  45         QTOP_EQ = 0,
  46         QTOP_CQ,
  47         QTOP_WQ,
  48         QTOP_RQ,
  49         QTOP_MQ,
  50         QTOP_LAST,
  51 } ocs_hw_qtop_entry_e;
  52
  53 typedef struct {
  54         ocs_hw_qtop_entry_e entry;
  55         uint8_t set_default;
  56         uint32_t len;
  57         uint8_t class;
  58         uint8_t ulp;
  59         uint8_t filter_mask;
  60 } ocs_hw_qtop_entry_t;
  61
  62 typedef struct {
  63         struct rq_config {
  64                 hw_eq_t *eq;
  65                 uint32_t len;
  66                 uint8_t class;
  67                 uint8_t ulp;
  68                 uint8_t filter_mask;
  69         } rq_cfg[16];
  70         uint32_t num_pairs;
  71 } ocs_hw_mrq_t;
  72
  73
  74 #define MAX_TOKENS                      256
  75 #define OCS_HW_MAX_QTOP_ENTRIES 200
  76
  77 typedef struct {
  78         ocs_os_handle_t os;
  79         ocs_hw_qtop_entry_t *entries;
  80         uint32_t alloc_count;
  81         uint32_t inuse_count;
  82         uint32_t entry_counts[QTOP_LAST];
  83         uint32_t rptcount[10];
  84         uint32_t rptcount_idx;
  85 } ocs_hw_qtop_t;
  86
  87 extern ocs_hw_qtop_t *ocs_hw_qtop_parse(ocs_hw_t *hw, const char *qtop_string);
  88 extern void ocs_hw_qtop_free(ocs_hw_qtop_t *qtop);
  89 extern const char *ocs_hw_qtop_entry_name(ocs_hw_qtop_entry_e entry);
  90 extern uint32_t ocs_hw_qtop_eq_count(ocs_hw_t *hw);
  91
  92 extern ocs_hw_rtn_e ocs_hw_init_queues(ocs_hw_t *hw, ocs_hw_qtop_t *qtop);
  93 extern void hw_thread_eq_handler(ocs_hw_t *hw, hw_eq_t *eq, uint32_t max_isr_time_msec);
  94 extern void hw_thread_cq_handler(ocs_hw_t *hw, hw_cq_t *cq);
  95 extern  hw_wq_t *ocs_hw_queue_next_wq(ocs_hw_t *hw, ocs_hw_io_t *io);
  96
  97 #endif /* __OCS_HW_QUEUES_H__ */