Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2/* Copyright(c) 2013 - 2019 Intel Corporation. */
3
4#ifndef _FM10K_TLV_H_
5#define _FM10K_TLV_H_
6
7/* forward declaration */
8struct fm10k_msg_data;
9
10#include "fm10k_type.h"
11
12/* Message / Argument header format
13 * 3 2 1 0
14 * 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
15 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
16 * | Length | Flags | Type / ID |
17 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
18 *
19 * The message header format described here is used for messages that are
20 * passed between the PF and the VF. To allow for messages larger then
21 * mailbox size we will provide a message with the above header and it
22 * will be segmented and transported to the mailbox to the other side where
23 * it is reassembled. It contains the following fields:
24 * Length: Length of the message in bytes excluding the message header
25 * Flags: TBD
26 * Type/ID: These will be the message/argument types we pass
27 */
28/* message data header */
29#define FM10K_TLV_ID_SHIFT 0
30#define FM10K_TLV_ID_SIZE 16
31#define FM10K_TLV_ID_MASK ((1u << FM10K_TLV_ID_SIZE) - 1)
32#define FM10K_TLV_FLAGS_SHIFT 16
33#define FM10K_TLV_FLAGS_MSG 0x1
34#define FM10K_TLV_FLAGS_SIZE 4
35#define FM10K_TLV_LEN_SHIFT 20
36#define FM10K_TLV_LEN_SIZE 12
37
38#define FM10K_TLV_HDR_LEN 4ul
39#define FM10K_TLV_LEN_ALIGN_MASK \
40 ((FM10K_TLV_HDR_LEN - 1) << FM10K_TLV_LEN_SHIFT)
41#define FM10K_TLV_LEN_ALIGN(tlv) \
42 (((tlv) + FM10K_TLV_LEN_ALIGN_MASK) & ~FM10K_TLV_LEN_ALIGN_MASK)
43#define FM10K_TLV_DWORD_LEN(tlv) \
44 ((u16)((FM10K_TLV_LEN_ALIGN(tlv)) >> (FM10K_TLV_LEN_SHIFT + 2)) + 1)
45
46#define FM10K_TLV_RESULTS_MAX 32
47
48enum fm10k_tlv_type {
49 FM10K_TLV_NULL_STRING,
50 FM10K_TLV_MAC_ADDR,
51 FM10K_TLV_BOOL,
52 FM10K_TLV_UNSIGNED,
53 FM10K_TLV_SIGNED,
54 FM10K_TLV_LE_STRUCT,
55 FM10K_TLV_NESTED,
56 FM10K_TLV_MAX_TYPE
57};
58
59#define FM10K_TLV_ERROR (~0u)
60
61struct fm10k_tlv_attr {
62 unsigned int id;
63 enum fm10k_tlv_type type;
64 u16 len;
65};
66
67#define FM10K_TLV_ATTR_NULL_STRING(id, len) { id, FM10K_TLV_NULL_STRING, len }
68#define FM10K_TLV_ATTR_MAC_ADDR(id) { id, FM10K_TLV_MAC_ADDR, 6 }
69#define FM10K_TLV_ATTR_BOOL(id) { id, FM10K_TLV_BOOL, 0 }
70#define FM10K_TLV_ATTR_U8(id) { id, FM10K_TLV_UNSIGNED, 1 }
71#define FM10K_TLV_ATTR_U16(id) { id, FM10K_TLV_UNSIGNED, 2 }
72#define FM10K_TLV_ATTR_U32(id) { id, FM10K_TLV_UNSIGNED, 4 }
73#define FM10K_TLV_ATTR_U64(id) { id, FM10K_TLV_UNSIGNED, 8 }
74#define FM10K_TLV_ATTR_S8(id) { id, FM10K_TLV_SIGNED, 1 }
75#define FM10K_TLV_ATTR_S16(id) { id, FM10K_TLV_SIGNED, 2 }
76#define FM10K_TLV_ATTR_S32(id) { id, FM10K_TLV_SIGNED, 4 }
77#define FM10K_TLV_ATTR_S64(id) { id, FM10K_TLV_SIGNED, 8 }
78#define FM10K_TLV_ATTR_LE_STRUCT(id, len) { id, FM10K_TLV_LE_STRUCT, len }
79#define FM10K_TLV_ATTR_NESTED(id) { id, FM10K_TLV_NESTED, 0 }
80#define FM10K_TLV_ATTR_LAST { FM10K_TLV_ERROR, 0, 0 }
81
82struct fm10k_msg_data {
83 unsigned int id;
84 const struct fm10k_tlv_attr *attr;
85 s32 (*func)(struct fm10k_hw *, u32 **,
86 struct fm10k_mbx_info *);
87};
88
89#define FM10K_MSG_HANDLER(id, attr, func) { id, attr, func }
90
91s32 fm10k_tlv_msg_init(u32 *, u16);
92s32 fm10k_tlv_attr_put_mac_vlan(u32 *, u16, const u8 *, u16);
93s32 fm10k_tlv_attr_get_mac_vlan(u32 *, u8 *, u16 *);
94s32 fm10k_tlv_attr_put_bool(u32 *, u16);
95s32 fm10k_tlv_attr_put_value(u32 *, u16, s64, u32);
96#define fm10k_tlv_attr_put_u8(msg, attr_id, val) \
97 fm10k_tlv_attr_put_value(msg, attr_id, val, 1)
98#define fm10k_tlv_attr_put_u16(msg, attr_id, val) \
99 fm10k_tlv_attr_put_value(msg, attr_id, val, 2)
100#define fm10k_tlv_attr_put_u32(msg, attr_id, val) \
101 fm10k_tlv_attr_put_value(msg, attr_id, val, 4)
102#define fm10k_tlv_attr_put_u64(msg, attr_id, val) \
103 fm10k_tlv_attr_put_value(msg, attr_id, val, 8)
104#define fm10k_tlv_attr_put_s8(msg, attr_id, val) \
105 fm10k_tlv_attr_put_value(msg, attr_id, val, 1)
106#define fm10k_tlv_attr_put_s16(msg, attr_id, val) \
107 fm10k_tlv_attr_put_value(msg, attr_id, val, 2)
108#define fm10k_tlv_attr_put_s32(msg, attr_id, val) \
109 fm10k_tlv_attr_put_value(msg, attr_id, val, 4)
110#define fm10k_tlv_attr_put_s64(msg, attr_id, val) \
111 fm10k_tlv_attr_put_value(msg, attr_id, val, 8)
112s32 fm10k_tlv_attr_get_value(u32 *, void *, u32);
113#define fm10k_tlv_attr_get_u8(attr, ptr) \
114 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u8))
115#define fm10k_tlv_attr_get_u16(attr, ptr) \
116 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u16))
117#define fm10k_tlv_attr_get_u32(attr, ptr) \
118 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u32))
119#define fm10k_tlv_attr_get_u64(attr, ptr) \
120 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u64))
121#define fm10k_tlv_attr_get_s8(attr, ptr) \
122 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s8))
123#define fm10k_tlv_attr_get_s16(attr, ptr) \
124 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s16))
125#define fm10k_tlv_attr_get_s32(attr, ptr) \
126 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s32))
127#define fm10k_tlv_attr_get_s64(attr, ptr) \
128 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s64))
129s32 fm10k_tlv_attr_put_le_struct(u32 *, u16, const void *, u32);
130s32 fm10k_tlv_attr_get_le_struct(u32 *, void *, u32);
131s32 fm10k_tlv_msg_parse(struct fm10k_hw *, u32 *, struct fm10k_mbx_info *,
132 const struct fm10k_msg_data *);
133s32 fm10k_tlv_msg_error(struct fm10k_hw *hw, u32 **results,
134 struct fm10k_mbx_info *);
135
136#define FM10K_TLV_MSG_ID_TEST 0
137
138enum fm10k_tlv_test_attr_id {
139 FM10K_TEST_MSG_UNSET,
140 FM10K_TEST_MSG_STRING,
141 FM10K_TEST_MSG_MAC_ADDR,
142 FM10K_TEST_MSG_U8,
143 FM10K_TEST_MSG_U16,
144 FM10K_TEST_MSG_U32,
145 FM10K_TEST_MSG_U64,
146 FM10K_TEST_MSG_S8,
147 FM10K_TEST_MSG_S16,
148 FM10K_TEST_MSG_S32,
149 FM10K_TEST_MSG_S64,
150 FM10K_TEST_MSG_LE_STRUCT,
151 FM10K_TEST_MSG_NESTED,
152 FM10K_TEST_MSG_RESULT,
153 FM10K_TEST_MSG_MAX
154};
155
156extern const struct fm10k_tlv_attr fm10k_tlv_msg_test_attr[];
157void fm10k_tlv_msg_test_create(u32 *, u32);
158s32 fm10k_tlv_msg_test(struct fm10k_hw *, u32 **, struct fm10k_mbx_info *);
159
160#define FM10K_TLV_MSG_TEST_HANDLER(func) \
161 FM10K_MSG_HANDLER(FM10K_TLV_MSG_ID_TEST, fm10k_tlv_msg_test_attr, func)
162#define FM10K_TLV_MSG_ERROR_HANDLER(func) \
163 FM10K_MSG_HANDLER(FM10K_TLV_ERROR, NULL, func)
164#endif /* _FM10K_MSG_H_ */
1/* Intel Ethernet Switch Host Interface Driver
2 * Copyright(c) 2013 - 2015 Intel Corporation.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
15 *
16 * Contact Information:
17 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
18 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
19 */
20
21#ifndef _FM10K_TLV_H_
22#define _FM10K_TLV_H_
23
24/* forward declaration */
25struct fm10k_msg_data;
26
27#include "fm10k_type.h"
28
29/* Message / Argument header format
30 * 3 2 1 0
31 * 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
32 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
33 * | Length | Flags | Type / ID |
34 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
35 *
36 * The message header format described here is used for messages that are
37 * passed between the PF and the VF. To allow for messages larger then
38 * mailbox size we will provide a message with the above header and it
39 * will be segmented and transported to the mailbox to the other side where
40 * it is reassembled. It contains the following fields:
41 * Length: Length of the message in bytes excluding the message header
42 * Flags: TBD
43 * Type/ID: These will be the message/argument types we pass
44 */
45/* message data header */
46#define FM10K_TLV_ID_SHIFT 0
47#define FM10K_TLV_ID_SIZE 16
48#define FM10K_TLV_ID_MASK ((1u << FM10K_TLV_ID_SIZE) - 1)
49#define FM10K_TLV_FLAGS_SHIFT 16
50#define FM10K_TLV_FLAGS_MSG 0x1
51#define FM10K_TLV_FLAGS_SIZE 4
52#define FM10K_TLV_LEN_SHIFT 20
53#define FM10K_TLV_LEN_SIZE 12
54
55#define FM10K_TLV_HDR_LEN 4ul
56#define FM10K_TLV_LEN_ALIGN_MASK \
57 ((FM10K_TLV_HDR_LEN - 1) << FM10K_TLV_LEN_SHIFT)
58#define FM10K_TLV_LEN_ALIGN(tlv) \
59 (((tlv) + FM10K_TLV_LEN_ALIGN_MASK) & ~FM10K_TLV_LEN_ALIGN_MASK)
60#define FM10K_TLV_DWORD_LEN(tlv) \
61 ((u16)((FM10K_TLV_LEN_ALIGN(tlv)) >> (FM10K_TLV_LEN_SHIFT + 2)) + 1)
62
63#define FM10K_TLV_RESULTS_MAX 32
64
65enum fm10k_tlv_type {
66 FM10K_TLV_NULL_STRING,
67 FM10K_TLV_MAC_ADDR,
68 FM10K_TLV_BOOL,
69 FM10K_TLV_UNSIGNED,
70 FM10K_TLV_SIGNED,
71 FM10K_TLV_LE_STRUCT,
72 FM10K_TLV_NESTED,
73 FM10K_TLV_MAX_TYPE
74};
75
76#define FM10K_TLV_ERROR (~0u)
77
78struct fm10k_tlv_attr {
79 unsigned int id;
80 enum fm10k_tlv_type type;
81 u16 len;
82};
83
84#define FM10K_TLV_ATTR_NULL_STRING(id, len) { id, FM10K_TLV_NULL_STRING, len }
85#define FM10K_TLV_ATTR_MAC_ADDR(id) { id, FM10K_TLV_MAC_ADDR, 6 }
86#define FM10K_TLV_ATTR_BOOL(id) { id, FM10K_TLV_BOOL, 0 }
87#define FM10K_TLV_ATTR_U8(id) { id, FM10K_TLV_UNSIGNED, 1 }
88#define FM10K_TLV_ATTR_U16(id) { id, FM10K_TLV_UNSIGNED, 2 }
89#define FM10K_TLV_ATTR_U32(id) { id, FM10K_TLV_UNSIGNED, 4 }
90#define FM10K_TLV_ATTR_U64(id) { id, FM10K_TLV_UNSIGNED, 8 }
91#define FM10K_TLV_ATTR_S8(id) { id, FM10K_TLV_SIGNED, 1 }
92#define FM10K_TLV_ATTR_S16(id) { id, FM10K_TLV_SIGNED, 2 }
93#define FM10K_TLV_ATTR_S32(id) { id, FM10K_TLV_SIGNED, 4 }
94#define FM10K_TLV_ATTR_S64(id) { id, FM10K_TLV_SIGNED, 8 }
95#define FM10K_TLV_ATTR_LE_STRUCT(id, len) { id, FM10K_TLV_LE_STRUCT, len }
96#define FM10K_TLV_ATTR_NESTED(id) { id, FM10K_TLV_NESTED }
97#define FM10K_TLV_ATTR_LAST { FM10K_TLV_ERROR }
98
99struct fm10k_msg_data {
100 unsigned int id;
101 const struct fm10k_tlv_attr *attr;
102 s32 (*func)(struct fm10k_hw *, u32 **,
103 struct fm10k_mbx_info *);
104};
105
106#define FM10K_MSG_HANDLER(id, attr, func) { id, attr, func }
107
108s32 fm10k_tlv_msg_init(u32 *, u16);
109s32 fm10k_tlv_attr_put_mac_vlan(u32 *, u16, const u8 *, u16);
110s32 fm10k_tlv_attr_get_mac_vlan(u32 *, u8 *, u16 *);
111s32 fm10k_tlv_attr_put_bool(u32 *, u16);
112s32 fm10k_tlv_attr_put_value(u32 *, u16, s64, u32);
113#define fm10k_tlv_attr_put_u8(msg, attr_id, val) \
114 fm10k_tlv_attr_put_value(msg, attr_id, val, 1)
115#define fm10k_tlv_attr_put_u16(msg, attr_id, val) \
116 fm10k_tlv_attr_put_value(msg, attr_id, val, 2)
117#define fm10k_tlv_attr_put_u32(msg, attr_id, val) \
118 fm10k_tlv_attr_put_value(msg, attr_id, val, 4)
119#define fm10k_tlv_attr_put_u64(msg, attr_id, val) \
120 fm10k_tlv_attr_put_value(msg, attr_id, val, 8)
121#define fm10k_tlv_attr_put_s8(msg, attr_id, val) \
122 fm10k_tlv_attr_put_value(msg, attr_id, val, 1)
123#define fm10k_tlv_attr_put_s16(msg, attr_id, val) \
124 fm10k_tlv_attr_put_value(msg, attr_id, val, 2)
125#define fm10k_tlv_attr_put_s32(msg, attr_id, val) \
126 fm10k_tlv_attr_put_value(msg, attr_id, val, 4)
127#define fm10k_tlv_attr_put_s64(msg, attr_id, val) \
128 fm10k_tlv_attr_put_value(msg, attr_id, val, 8)
129s32 fm10k_tlv_attr_get_value(u32 *, void *, u32);
130#define fm10k_tlv_attr_get_u8(attr, ptr) \
131 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u8))
132#define fm10k_tlv_attr_get_u16(attr, ptr) \
133 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u16))
134#define fm10k_tlv_attr_get_u32(attr, ptr) \
135 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u32))
136#define fm10k_tlv_attr_get_u64(attr, ptr) \
137 fm10k_tlv_attr_get_value(attr, ptr, sizeof(u64))
138#define fm10k_tlv_attr_get_s8(attr, ptr) \
139 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s8))
140#define fm10k_tlv_attr_get_s16(attr, ptr) \
141 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s16))
142#define fm10k_tlv_attr_get_s32(attr, ptr) \
143 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s32))
144#define fm10k_tlv_attr_get_s64(attr, ptr) \
145 fm10k_tlv_attr_get_value(attr, ptr, sizeof(s64))
146s32 fm10k_tlv_attr_put_le_struct(u32 *, u16, const void *, u32);
147s32 fm10k_tlv_attr_get_le_struct(u32 *, void *, u32);
148s32 fm10k_tlv_msg_parse(struct fm10k_hw *, u32 *, struct fm10k_mbx_info *,
149 const struct fm10k_msg_data *);
150s32 fm10k_tlv_msg_error(struct fm10k_hw *hw, u32 **results,
151 struct fm10k_mbx_info *);
152
153#define FM10K_TLV_MSG_ID_TEST 0
154
155enum fm10k_tlv_test_attr_id {
156 FM10K_TEST_MSG_UNSET,
157 FM10K_TEST_MSG_STRING,
158 FM10K_TEST_MSG_MAC_ADDR,
159 FM10K_TEST_MSG_U8,
160 FM10K_TEST_MSG_U16,
161 FM10K_TEST_MSG_U32,
162 FM10K_TEST_MSG_U64,
163 FM10K_TEST_MSG_S8,
164 FM10K_TEST_MSG_S16,
165 FM10K_TEST_MSG_S32,
166 FM10K_TEST_MSG_S64,
167 FM10K_TEST_MSG_LE_STRUCT,
168 FM10K_TEST_MSG_NESTED,
169 FM10K_TEST_MSG_RESULT,
170 FM10K_TEST_MSG_MAX
171};
172
173extern const struct fm10k_tlv_attr fm10k_tlv_msg_test_attr[];
174void fm10k_tlv_msg_test_create(u32 *, u32);
175s32 fm10k_tlv_msg_test(struct fm10k_hw *, u32 **, struct fm10k_mbx_info *);
176
177#define FM10K_TLV_MSG_TEST_HANDLER(func) \
178 FM10K_MSG_HANDLER(FM10K_TLV_MSG_ID_TEST, fm10k_tlv_msg_test_attr, func)
179#define FM10K_TLV_MSG_ERROR_HANDLER(func) \
180 FM10K_MSG_HANDLER(FM10K_TLV_ERROR, NULL, func)
181#endif /* _FM10K_MSG_H_ */