drivers/net/qede/base/ecore_sp_commands.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.com
   5  *
   6  * See LICENSE.qede_pmd for copyright and licensing details.
   7  */
   8
   9 #ifndef __ECORE_SP_COMMANDS_H__
  10 #define __ECORE_SP_COMMANDS_H__
  11
  12 #include "ecore.h"
  13 #include "ecore_spq.h"
  14 #include "ecore_sp_api.h"
  15
  16 #define ECORE_SP_EQ_COMPLETION  0x01
  17 #define ECORE_SP_CQE_COMPLETION 0x02
  18
  19 struct ecore_sp_init_data {
  20         /* The CID and FID aren't necessarily derived from hwfn,
  21          * e.g., in IOV scenarios. CID might defer between SPQ and
  22          * other elements.
  23          */
  24         u32 cid;
  25         u16 opaque_fid;
  26
  27         /* Information regarding operation upon sending & completion */
  28         enum spq_mode comp_mode;
  29         struct ecore_spq_comp_cb *p_comp_data;
  30
  31 };
  32
  33 /**
  34  * @brief Acquire and initialize and SPQ entry for a given ramrod.
  35  *
  36  * @param p_hwfn
  37  * @param pp_ent - will be filled with a pointer to an entry upon success
  38  * @param cmd - dependent upon protocol
  39  * @param protocol
  40  * @param p_data - various configuration required for ramrod
  41  *
  42  * @return ECORE_SUCCESS upon success, otherwise failure.
  43  */
  44 enum _ecore_status_t ecore_sp_init_request(struct ecore_hwfn *p_hwfn,
  45                                            struct ecore_spq_entry **pp_ent,
  46                                            u8 cmd,
  47                                            u8 protocol,
  48                                            struct ecore_sp_init_data *p_data);
  49
  50 /**
  51  * @brief ecore_sp_pf_start - PF Function Start Ramrod
  52  *
  53  * This ramrod is sent to initialize a physical function (PF). It will
  54  * configure the function related parameters and write its completion to the
  55  * event ring specified in the parameters.
  56  *
  57  * Ramrods complete on the common event ring for the PF. This ring is
  58  * allocated by the driver on host memory and its parameters are written
  59  * to the internal RAM of the UStorm by the Function Start Ramrod.
  60  *
  61  * @param p_hwfn
  62  * @param p_tunn - pf start tunneling configuration
  63  * @param mode
  64  * @param allow_npar_tx_switch - npar tx switching to be used
  65  *        for vports configured for tx-switching.
  66  *
  67  * @return enum _ecore_status_t
  68  */
  69
  70 enum _ecore_status_t ecore_sp_pf_start(struct ecore_hwfn *p_hwfn,
  71                                        struct ecore_tunn_start_params *p_tunn,
  72                                        enum ecore_mf_mode mode,
  73                                        bool allow_npar_tx_switch);
  74
  75 /**
  76  * @brief ecore_sp_pf_update_tunn_cfg - PF Function Tunnel configuration
  77  *                                      update  Ramrod
  78  *
  79  * This ramrod is sent to update a tunneling configuration
  80  * for a physical function (PF).
  81  *
  82  * @param p_hwfn
  83  * @param p_tunn - pf update tunneling parameters
  84  * @param comp_mode - completion mode
  85  * @param p_comp_data - callback function
  86  *
  87  * @return enum _ecore_status_t
  88  */
  89
  90 enum _ecore_status_t
  91 ecore_sp_pf_update_tunn_cfg(struct ecore_hwfn *p_hwfn,
  92                             struct ecore_tunn_update_params *p_tunn,
  93                             enum spq_mode comp_mode,
  94                             struct ecore_spq_comp_cb *p_comp_data);
  95
  96 /**
  97  * @brief ecore_sp_pf_update - PF Function Update Ramrod
  98  *
  99  * This ramrod updates function-related parameters. Every parameter can be
 100  * updated independently, according to configuration flags.
 101  *
 102  * @note Final phase API.
 103  *
 104  * @param p_hwfn
 105  *
 106  * @return enum _ecore_status_t
 107  */
 108
 109 enum _ecore_status_t ecore_sp_pf_update(struct ecore_hwfn *p_hwfn);
 110
 111 /**
 112  * @brief ecore_sp_pf_stop - PF Function Stop Ramrod
 113  *
 114  * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
 115  * sent and the last completion written to the PFs Event Ring. This ramrod also
 116  * deletes the context for the Slowhwfn connection on this PF.
 117  *
 118  * @note Not required for first packet.
 119  *
 120  * @param p_hwfn
 121  *
 122  * @return enum _ecore_status_t
 123  */
 124
 125 enum _ecore_status_t ecore_sp_pf_stop(struct ecore_hwfn *p_hwfn);
 126
 127 /**
 128  * @brief ecore_sp_heartbeat_ramrod - Send empty Ramrod
 129  *
 130  * @param p_hwfn
 131  *
 132  * @return enum _ecore_status_t
 133  */
 134
 135 enum _ecore_status_t ecore_sp_heartbeat_ramrod(struct ecore_hwfn *p_hwfn);
 136
 137 #endif /*__ECORE_SP_COMMANDS_H__*/