sys/dev/qlnx/qlnxe/ecore_init_ops.h

   1 /*
   2  * Copyright (c) 2017-2018 Cavium, Inc.
   3  * All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions
   7  *  are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  *  2. Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  *
  15  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  19  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  *  POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  *
  29  */
  30
  31 #ifndef __ECORE_INIT_OPS__
  32 #define __ECORE_INIT_OPS__
  33
  34 #include "ecore.h"
  35
  36 /**
  37  * @brief ecore_init_iro_array - init iro_arr.
  38  *
  39  *
  40  * @param p_dev
  41  */
  42 void ecore_init_iro_array(struct ecore_dev *p_dev);
  43
  44 /**
  45  * @brief ecore_init_run - Run the init-sequence.
  46  *
  47  *
  48  * @param p_hwfn
  49  * @param p_ptt
  50  * @param phase
  51  * @param phase_id
  52  * @param modes
  53  * @return _ecore_status_t
  54  */
  55 enum _ecore_status_t ecore_init_run(struct ecore_hwfn *p_hwfn,
  56                                     struct ecore_ptt  *p_ptt,
  57                                     int               phase,
  58                                     int               phase_id,
  59                                     int               modes);
  60
  61 /**
  62  * @brief ecore_init_hwfn_allocate - Allocate RT array, Store 'values' ptrs.
  63  *
  64  *
  65  * @param p_hwfn
  66  *
  67  * @return _ecore_status_t
  68  */
  69 enum _ecore_status_t ecore_init_alloc(struct ecore_hwfn *p_hwfn);
  70
  71 /**
  72  * @brief ecore_init_hwfn_deallocate
  73  *
  74  *
  75  * @param p_hwfn
  76  */
  77 void ecore_init_free(struct ecore_hwfn *p_hwfn);
  78
  79
  80 /**
  81  * @brief ecore_init_clear_rt_data - Clears the runtime init array.
  82  *
  83  *
  84  * @param p_hwfn
  85  */
  86 void ecore_init_clear_rt_data(struct ecore_hwfn *p_hwfn);
  87
  88 /**
  89  * @brief ecore_init_store_rt_reg - Store a configuration value in the RT array.
  90  *
  91  *
  92  * @param p_hwfn
  93  * @param rt_offset
  94  * @param val
  95  */
  96 void ecore_init_store_rt_reg(struct ecore_hwfn *p_hwfn,
  97                              u32                rt_offset,
  98                              u32                val);
  99
 100 #define STORE_RT_REG(hwfn, offset, val)                         \
 101         ecore_init_store_rt_reg(hwfn, offset, val)
 102
 103 #define OVERWRITE_RT_REG(hwfn, offset, val)                     \
 104         ecore_init_store_rt_reg(hwfn, offset, val)
 105
 106 /**
 107 * @brief
 108 *
 109 *
 110 * @param p_hwfn
 111 * @param rt_offset
 112 * @param val
 113 * @param size
 114 */
 115
 116 void ecore_init_store_rt_agg(struct ecore_hwfn *p_hwfn,
 117                              u32               rt_offset,
 118                              u32               *val,
 119                              osal_size_t       size);
 120
 121 #define STORE_RT_REG_AGG(hwfn, offset, val)                     \
 122         ecore_init_store_rt_agg(hwfn, offset, (u32*)&val, sizeof(val))
 123
 124
 125 /**
 126  * @brief
 127  *      Initialize GTT global windows and set admin window
 128  *      related params of GTT/PTT to default values.
 129  *
 130  * @param p_hwfn
 131  */
 132 void ecore_gtt_init(struct ecore_hwfn *p_hwfn,
 133                     struct ecore_ptt *p_ptt);
 134 #endif /* __ECORE_INIT_OPS__ */