1/* SPDX-License-Identifier: GPL-2.0 */
  2/* Copyright(c) 1999 - 2018 Intel Corporation. */
  3
  4#ifndef _IXGBE_MBX_H_
  5#define _IXGBE_MBX_H_
  6
  7#include <linux/types.h>
  8
  9#define IXGBE_VFMAILBOX_SIZE        16 /* 16 32 bit words - 64 bytes */
 10
 11#define IXGBE_VFMAILBOX             0x002FC
 12#define IXGBE_VFMBMEM               0x00200
 13
 14#define IXGBE_PFMAILBOX_STS   0x00000001 /* Initiate message send to VF */
 15#define IXGBE_PFMAILBOX_ACK   0x00000002 /* Ack message recv'd from VF */
 16#define IXGBE_PFMAILBOX_VFU   0x00000004 /* VF owns the mailbox buffer */
 17#define IXGBE_PFMAILBOX_PFU   0x00000008 /* PF owns the mailbox buffer */
 18#define IXGBE_PFMAILBOX_RVFU  0x00000010 /* Reset VFU - used when VF stuck */
 19
 20#define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
 21#define IXGBE_MBVFICR_VFREQ_VF1  0x00000001 /* bit for VF 1 message */
 22#define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
 23#define IXGBE_MBVFICR_VFACK_VF1  0x00010000 /* bit for VF 1 ack */
 24
 25
 26/* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
 27 * PF.  The reverse is true if it is IXGBE_PF_*.
 28 * Message ACK's are the value or'd with 0xF0000000
 29 */
 30#define IXGBE_VT_MSGTYPE_ACK      0x80000000  /* Messages below or'd with
 31					       * this are the ACK */
 32#define IXGBE_VT_MSGTYPE_NACK     0x40000000  /* Messages below or'd with
 33					       * this are the NACK */
 34#define IXGBE_VT_MSGTYPE_CTS      0x20000000  /* Indicates that VF is still
 35						 clear to send requests */
 36#define IXGBE_VT_MSGINFO_SHIFT    16
 37/* bits 23:16 are used for exra info for certain messages */
 38#define IXGBE_VT_MSGINFO_MASK     (0xFF << IXGBE_VT_MSGINFO_SHIFT)
 39
 40/* definitions to support mailbox API version negotiation */
 41
 42/*
 43 * Each element denotes a version of the API; existing numbers may not
 44 * change; any additions must go at the end
 45 */
 46enum ixgbe_pfvf_api_rev {
 47	ixgbe_mbox_api_10,	/* API version 1.0, linux/freebsd VF driver */
 48	ixgbe_mbox_api_20,	/* API version 2.0, solaris Phase1 VF driver */
 49	ixgbe_mbox_api_11,	/* API version 1.1, linux/freebsd VF driver */
 50	ixgbe_mbox_api_12,	/* API version 1.2, linux/freebsd VF driver */
 51	ixgbe_mbox_api_13,	/* API version 1.3, linux/freebsd VF driver */
 52	ixgbe_mbox_api_14,	/* API version 1.4, linux/freebsd VF driver */
 53	/* This value should always be last */
 54	ixgbe_mbox_api_unknown,	/* indicates that API version is not known */
 55};
 56
 57/* mailbox API, legacy requests */
 58#define IXGBE_VF_RESET            0x01 /* VF requests reset */
 59#define IXGBE_VF_SET_MAC_ADDR     0x02 /* VF requests PF to set MAC addr */
 60#define IXGBE_VF_SET_MULTICAST    0x03 /* VF requests PF to set MC addr */
 61#define IXGBE_VF_SET_VLAN         0x04 /* VF requests PF to set VLAN */
 62
 63/* mailbox API, version 1.0 VF requests */
 64#define IXGBE_VF_SET_LPE	0x05 /* VF requests PF to set VMOLR.LPE */
 65#define IXGBE_VF_SET_MACVLAN	0x06 /* VF requests PF for unicast filter */
 66#define IXGBE_VF_API_NEGOTIATE	0x08 /* negotiate API version */
 67
 68/* mailbox API, version 1.1 VF requests */
 69#define IXGBE_VF_GET_QUEUES	0x09 /* get queue configuration */
 70
 71/* GET_QUEUES return data indices within the mailbox */
 72#define IXGBE_VF_TX_QUEUES	1	/* number of Tx queues supported */
 73#define IXGBE_VF_RX_QUEUES	2	/* number of Rx queues supported */
 74#define IXGBE_VF_TRANS_VLAN	3	/* Indication of port vlan */
 75#define IXGBE_VF_DEF_QUEUE	4	/* Default queue offset */
 76
 77/* mailbox API, version 1.2 VF requests */
 78#define IXGBE_VF_GET_RETA	0x0a	/* VF request for RETA */
 79#define IXGBE_VF_GET_RSS_KEY	0x0b	/* get RSS key */
 80
 81#define IXGBE_VF_UPDATE_XCAST_MODE	0x0c
 82
 83/* mailbox API, version 1.4 VF requests */
 84#define IXGBE_VF_IPSEC_ADD	0x0d
 85#define IXGBE_VF_IPSEC_DEL	0x0e
 86
 87#define IXGBE_VF_GET_LINK_STATE 0x10 /* get vf link state */
 88
 89/* length of permanent address message returned from PF */
 90#define IXGBE_VF_PERMADDR_MSG_LEN 4
 91/* word in permanent address message with the current multicast type */
 92#define IXGBE_VF_MC_TYPE_WORD     3
 93
 94#define IXGBE_PF_CONTROL_MSG      0x0100 /* PF control message */
 95
 96#define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
 97#define IXGBE_VF_MBX_INIT_DELAY   500  /* microseconds between retries */
 98
 99struct ixgbe_hw;
100
101int ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16);
102int ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16);
103int ixgbe_check_for_msg(struct ixgbe_hw *, u16);
104int ixgbe_check_for_ack(struct ixgbe_hw *, u16);
105int ixgbe_check_for_rst(struct ixgbe_hw *, u16);
106#ifdef CONFIG_PCI_IOV
107void ixgbe_init_mbx_params_pf(struct ixgbe_hw *);
108#endif /* CONFIG_PCI_IOV */
109
110struct ixgbe_mbx_operations {
111	int (*init_params)(struct ixgbe_hw *hw);
112	int (*read)(struct ixgbe_hw *hw, u32 *msg, u16 size, u16 vf_number);
113	int (*write)(struct ixgbe_hw *hw, u32 *msg, u16 size, u16 vf_number);
114	int (*read_posted)(struct ixgbe_hw *hw, u32 *msg, u16 size, u16 mbx_id);
115	int (*write_posted)(struct ixgbe_hw *hw, u32 *msg, u16 size,
116			    u16 mbx_id);
117	int (*check_for_msg)(struct ixgbe_hw *hw, u16 vf_number);
118	int (*check_for_ack)(struct ixgbe_hw *hw, u16 vf_number);
119	int (*check_for_rst)(struct ixgbe_hw *hw, u16 vf_number);
120};
121
122extern const struct ixgbe_mbx_operations mbx_ops_generic;
123
124#endif /* _IXGBE_MBX_H_ */