drivers/net/fm10k/base/fm10k_mbx.h

   1 /*******************************************************************************
   2
   3 Copyright (c) 2013 - 2015, Intel Corporation
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. 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 distribution.
  15
  16  3. Neither the name of the Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived from
  18     this software without specific prior written permission.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 POSSIBILITY OF SUCH DAMAGE.
  31
  32 ***************************************************************************/
  33
  34 #ifndef _FM10K_MBX_H_
  35 #define _FM10K_MBX_H_
  36
  37 /* forward declaration */
  38 struct fm10k_mbx_info;
  39
  40 #include "fm10k_type.h"
  41 #include "fm10k_tlv.h"
  42
  43 /* PF Mailbox Registers */
  44 #define FM10K_MBMEM(_n)         ((_n) + 0x18000)
  45 #define FM10K_MBMEM_VF(_n, _m)  (((_n) * 0x10) + (_m) + 0x18000)
  46 #define FM10K_MBMEM_SM(_n)      ((_n) + 0x18400)
  47 #define FM10K_MBMEM_PF(_n)      ((_n) + 0x18600)
  48 /* XOR provides means of switching from Tx to Rx FIFO */
  49 #define FM10K_MBMEM_PF_XOR      (FM10K_MBMEM_SM(0) ^ FM10K_MBMEM_PF(0))
  50 #define FM10K_MBX(_n)           ((_n) + 0x18800)
  51 #define FM10K_MBX_REQ                           0x00000002
  52 #define FM10K_MBX_ACK                           0x00000004
  53 #define FM10K_MBX_REQ_INTERRUPT                 0x00000008
  54 #define FM10K_MBX_ACK_INTERRUPT                 0x00000010
  55 #define FM10K_MBX_INTERRUPT_ENABLE              0x00000020
  56 #define FM10K_MBX_INTERRUPT_DISABLE             0x00000040
  57 #define FM10K_MBICR(_n)         ((_n) + 0x18840)
  58 #define FM10K_GMBX              0x18842
  59
  60 /* VF Mailbox Registers */
  61 #define FM10K_VFMBX             0x00010
  62 #define FM10K_VFMBMEM(_n)       ((_n) + 0x00020)
  63 #define FM10K_VFMBMEM_LEN       16
  64 #define FM10K_VFMBMEM_VF_XOR    (FM10K_VFMBMEM_LEN / 2)
  65
  66 /* Delays/timeouts */
  67 #define FM10K_MBX_DISCONNECT_TIMEOUT            500
  68 #define FM10K_MBX_POLL_DELAY                    19
  69 #define FM10K_MBX_INT_DELAY                     20
  70
  71 #define FM10K_WRITE_MBX(hw, reg, value) FM10K_WRITE_REG(hw, reg, value)
  72
  73 /* PF/VF Mailbox state machine
  74  *
  75  * +----------+     connect()   +----------+
  76  * |  CLOSED  | --------------> |  CONNECT |
  77  * +----------+                 +----------+
  78  *   ^                            ^      |
  79  *   | rcv:           rcv:        |      | rcv:
  80  *   |  Connect        Disconnect |      |  Connect
  81  *   |  Disconnect     Error      |      |  Data
  82  *   |                            |      |
  83  *   |                            |      V
  84  * +----------+   disconnect()  +----------+
  85  * |DISCONNECT| <-------------- |   OPEN   |
  86  * +----------+                 +----------+
  87  *
  88  * The diagram above describes the PF/VF mailbox state machine.  There
  89  * are four main states to this machine.
  90  * Closed: This state represents a mailbox that is in a standby state
  91  *         with interrupts disabled.  In this state the mailbox should not
  92  *         read the mailbox or write any data.  The only means of exiting
  93  *         this state is for the system to make the connect() call for the
  94  *         mailbox, it will then transition to the connect state.
  95  * Connect: In this state the mailbox is seeking a connection.  It will
  96  *          post a connect message with no specified destination and will
  97  *          wait for a reply from the other side of the mailbox.  This state
  98  *          is exited when either a connect with the local mailbox as the
  99  *          destination is received or when a data message is received with
 100  *          a valid sequence number.
 101  * Open: In this state the mailbox is able to transfer data between the local
 102  *       entity and the remote.  It will fall back to connect in the event of
 103  *       receiving either an error message, or a disconnect message.  It will
 104  *       transition to disconnect on a call to disconnect();
 105  * Disconnect: In this state the mailbox is attempting to gracefully terminate
 106  *             the connection.  It will do so at the first point where it knows
 107  *             that the remote endpoint is either done sending, or when the
 108  *             remote endpoint has fallen back into connect.
 109  */
 110 enum fm10k_mbx_state {
 111         FM10K_STATE_CLOSED,
 112         FM10K_STATE_CONNECT,
 113         FM10K_STATE_OPEN,
 114         FM10K_STATE_DISCONNECT,
 115 };
 116
 117 /* PF/VF Mailbox header format
 118  *    3                   2                   1                   0
 119  *  1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
 120  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 121  * |        Size/Err_no/CRC        | Rsvd0 | Head  | Tail  | Type  |
 122  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 123  *
 124  * The layout above describes the format for the header used in the PF/VF
 125  * mailbox.  The header is broken out into the following fields:
 126  * Type: There are 4 supported message types
 127  *              0x8: Data header - used to transport message data
 128  *              0xC: Connect header - used to establish connection
 129  *              0xD: Disconnect header - used to tear down a connection
 130  *              0xE: Error header - used to address message exceptions
 131  * Tail: Tail index for local FIFO
 132  *              Tail index actually consists of two parts.  The MSB of
 133  *              the head is a loop tracker, it is 0 on an even numbered
 134  *              loop through the FIFO, and 1 on the odd numbered loops.
 135  *              To get the actual mailbox offset based on the tail it
 136  *              is necessary to add bit 3 to bit 0 and clear bit 3.  This
 137  *              gives us a valid range of 0x1 - 0xE.
 138  * Head: Head index for remote FIFO
 139  *              Head index follows the same format as the tail index.
 140  * Rsvd0: Reserved 0 portion of the mailbox header
 141  * CRC: Running CRC for all data since connect plus current message header
 142  * Size: Maximum message size - Applies only to connect headers
 143  *              The maximum message size is provided during connect to avoid
 144  *              jamming the mailbox with messages that do not fit.
 145  * Err_no: Error number - Applies only to error headers
 146  *              The error number provides an indication of the type of error
 147  *              experienced.
 148  */
 149
 150 /* macros for retrieving and setting header values */
 151 #define FM10K_MSG_HDR_MASK(name) \
 152         ((0x1u << FM10K_MSG_##name##_SIZE) - 1)
 153 #define FM10K_MSG_HDR_FIELD_SET(value, name) \
 154         (((u32)(value) & FM10K_MSG_HDR_MASK(name)) << FM10K_MSG_##name##_SHIFT)
 155 #define FM10K_MSG_HDR_FIELD_GET(value, name) \
 156         ((u16)((value) >> FM10K_MSG_##name##_SHIFT) & FM10K_MSG_HDR_MASK(name))
 157
 158 /* offsets shared between all headers */
 159 #define FM10K_MSG_TYPE_SHIFT                    0
 160 #define FM10K_MSG_TYPE_SIZE                     4
 161 #define FM10K_MSG_TAIL_SHIFT                    4
 162 #define FM10K_MSG_TAIL_SIZE                     4
 163 #define FM10K_MSG_HEAD_SHIFT                    8
 164 #define FM10K_MSG_HEAD_SIZE                     4
 165 #define FM10K_MSG_RSVD0_SHIFT                   12
 166 #define FM10K_MSG_RSVD0_SIZE                    4
 167
 168 /* offsets for data/disconnect headers */
 169 #define FM10K_MSG_CRC_SHIFT                     16
 170 #define FM10K_MSG_CRC_SIZE                      16
 171
 172 /* offsets for connect headers */
 173 #define FM10K_MSG_CONNECT_SIZE_SHIFT            16
 174 #define FM10K_MSG_CONNECT_SIZE_SIZE             16
 175
 176 /* offsets for error headers */
 177 #define FM10K_MSG_ERR_NO_SHIFT                  16
 178 #define FM10K_MSG_ERR_NO_SIZE                   16
 179
 180 enum fm10k_msg_type {
 181         FM10K_MSG_DATA                  = 0x8,
 182         FM10K_MSG_CONNECT               = 0xC,
 183         FM10K_MSG_DISCONNECT            = 0xD,
 184         FM10K_MSG_ERROR                 = 0xE,
 185 };
 186
 187 /* HNI/SM Mailbox FIFO format
 188  *    3                   2                   1                   0
 189  *  1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
 190  * +-------+-----------------------+-------+-----------------------+
 191  * | Error |      Remote Head      |Version|      Local Tail       |
 192  * +-------+-----------------------+-------+-----------------------+
 193  * |                                                               |
 194  * .                        Local FIFO Data                        .
 195  * .                                                               .
 196  * +-------+-----------------------+-------+-----------------------+
 197  *
 198  * The layout above describes the format for the FIFOs used by the host
 199  * network interface and the switch manager to communicate messages back
 200  * and forth.  Both the HNI and the switch maintain one such FIFO.  The
 201  * layout in memory has the switch manager FIFO followed immediately by
 202  * the HNI FIFO.  For this reason I am using just the pointer to the
 203  * HNI FIFO in the mailbox ops as the offset between the two is fixed.
 204  *
 205  * The header for the FIFO is broken out into the following fields:
 206  * Local Tail:  Offset into FIFO region for next DWORD to write.
 207  * Version:  Version info for mailbox, only values of 0/1 are supported.
 208  * Remote Head:  Offset into remote FIFO to indicate how much we have read.
 209  * Error: Error indication, values TBD.
 210  */
 211
 212 /* version number for switch manager mailboxes */
 213 #define FM10K_SM_MBX_VERSION            1
 214 #define FM10K_SM_MBX_FIFO_LEN           (FM10K_MBMEM_PF_XOR - 1)
 215
 216 /* offsets shared between all SM FIFO headers */
 217 #define FM10K_MSG_SM_TAIL_SHIFT                 0
 218 #define FM10K_MSG_SM_TAIL_SIZE                  12
 219 #define FM10K_MSG_SM_VER_SHIFT                  12
 220 #define FM10K_MSG_SM_VER_SIZE                   4
 221 #define FM10K_MSG_SM_HEAD_SHIFT                 16
 222 #define FM10K_MSG_SM_HEAD_SIZE                  12
 223 #define FM10K_MSG_SM_ERR_SHIFT                  28
 224 #define FM10K_MSG_SM_ERR_SIZE                   4
 225
 226 /* All error messages returned by mailbox functions
 227  * The value -511 is 0xFE01 in hex.  The idea is to order the errors
 228  * from 0xFE01 - 0xFEFF so error codes are easily visible in the mailbox
 229  * messages.  This also helps to avoid error number collisions as Linux
 230  * doesn't appear to use error numbers 256 - 511.
 231  */
 232 #define FM10K_MBX_ERR(_n) ((_n) - 512)
 233 #define FM10K_MBX_ERR_NO_MBX            FM10K_MBX_ERR(0x01)
 234 #define FM10K_MBX_ERR_NO_SPACE          FM10K_MBX_ERR(0x03)
 235 #define FM10K_MBX_ERR_TAIL              FM10K_MBX_ERR(0x05)
 236 #define FM10K_MBX_ERR_HEAD              FM10K_MBX_ERR(0x06)
 237 #define FM10K_MBX_ERR_SRC               FM10K_MBX_ERR(0x08)
 238 #define FM10K_MBX_ERR_TYPE              FM10K_MBX_ERR(0x09)
 239 #define FM10K_MBX_ERR_SIZE              FM10K_MBX_ERR(0x0B)
 240 #define FM10K_MBX_ERR_BUSY              FM10K_MBX_ERR(0x0C)
 241 #define FM10K_MBX_ERR_RSVD0             FM10K_MBX_ERR(0x0E)
 242 #define FM10K_MBX_ERR_CRC               FM10K_MBX_ERR(0x0F)
 243
 244 #define FM10K_MBX_CRC_SEED              0xFFFF
 245
 246 struct fm10k_mbx_ops {
 247         s32 (*connect)(struct fm10k_hw *, struct fm10k_mbx_info *);
 248         void (*disconnect)(struct fm10k_hw *, struct fm10k_mbx_info *);
 249         bool (*rx_ready)(struct fm10k_mbx_info *);
 250         bool (*tx_ready)(struct fm10k_mbx_info *, u16);
 251         bool (*tx_complete)(struct fm10k_mbx_info *);
 252         s32 (*enqueue_tx)(struct fm10k_hw *, struct fm10k_mbx_info *,
 253                           const u32 *);
 254         s32 (*process)(struct fm10k_hw *, struct fm10k_mbx_info *);
 255         s32 (*register_handlers)(struct fm10k_mbx_info *,
 256                                  const struct fm10k_msg_data *);
 257 };
 258
 259 struct fm10k_mbx_fifo {
 260         u32 *buffer;
 261         u16 head;
 262         u16 tail;
 263         u16 size;
 264 };
 265
 266 /* size of buffer to be stored in mailbox for FIFOs */
 267 #define FM10K_MBX_TX_BUFFER_SIZE        512
 268 #define FM10K_MBX_RX_BUFFER_SIZE        128
 269 #define FM10K_MBX_BUFFER_SIZE \
 270         (FM10K_MBX_TX_BUFFER_SIZE + FM10K_MBX_RX_BUFFER_SIZE)
 271
 272 /* minimum and maximum message size in dwords */
 273 #define FM10K_MBX_MSG_MAX_SIZE \
 274         ((FM10K_MBX_TX_BUFFER_SIZE - 1) & (FM10K_MBX_RX_BUFFER_SIZE - 1))
 275 #define FM10K_VFMBX_MSG_MTU     ((FM10K_VFMBMEM_LEN / 2) - 1)
 276
 277 #define FM10K_MBX_INIT_TIMEOUT  2000 /* number of retries on mailbox */
 278 #define FM10K_MBX_INIT_DELAY    500  /* microseconds between retries */
 279
 280 struct fm10k_mbx_info {
 281         /* function pointers for mailbox operations */
 282         struct fm10k_mbx_ops ops;
 283         const struct fm10k_msg_data *msg_data;
 284
 285         /* message FIFOs */
 286         struct fm10k_mbx_fifo rx;
 287         struct fm10k_mbx_fifo tx;
 288
 289         /* delay for handling timeouts */
 290         u32 timeout;
 291         u32 usec_delay;
 292
 293         /* mailbox state info */
 294         u32 mbx_reg, mbmem_reg, mbx_lock, mbx_hdr;
 295         u16 max_size, mbmem_len;
 296         u16 tail, tail_len, pulled;
 297         u16 head, head_len, pushed;
 298         u16 local, remote;
 299         enum fm10k_mbx_state state;
 300
 301         /* result of last mailbox test */
 302         s32 test_result;
 303
 304         /* statistics */
 305         u64 tx_busy;
 306         u64 tx_dropped;
 307         u64 tx_messages;
 308         u64 tx_dwords;
 309         u64 tx_mbmem_pulled;
 310         u64 rx_messages;
 311         u64 rx_dwords;
 312         u64 rx_mbmem_pushed;
 313         u64 rx_parse_err;
 314
 315         /* Buffer to store messages */
 316         u32 buffer[FM10K_MBX_BUFFER_SIZE];
 317 };
 318
 319 s32 fm10k_pfvf_mbx_init(struct fm10k_hw *, struct fm10k_mbx_info *,
 320                         const struct fm10k_msg_data *, u8);
 321 s32 fm10k_sm_mbx_init(struct fm10k_hw *, struct fm10k_mbx_info *,
 322                       const struct fm10k_msg_data *);
 323
 324 #endif /* _FM10K_MBX_H_ */