iPXE
mcdi.h
Go to the documentation of this file.
1/****************************************************************************
2 * Driver for Solarflare network controllers and boards
3 *
4 * Written by Martin Habets <habetsm.xilinx@gmail.com>, maintained
5 * by <pre-boot-drivers@xilinx.com>
6 *
7 * Copyright 2012-2019 Solarflare Communications Inc.
8 * Copyright 2019-2020 Xilinx Inc.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation; either version 2 of the
13 * License, or any later version.
14 *
15 * You can also choose to distribute this program under the terms of
16 * the Unmodified Binary Distribution Licence (as given in the file
17 * COPYING.UBDL), provided that you have satisfied its requirements.
18 */
19#ifndef SFC_MCDI_H
20#define SFC_MCDI_H
21
22FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
23
24#ifndef DIV_ROUND_UP
25#define DIV_ROUND_UP(n, d) (((n) + (d) - 1) / (d))
26#endif
27
28#define MCDI_SEQ_MASK 0xf
29
30/* We expect that 16- and 32-bit fields in MCDI requests and responses
31 * are appropriately aligned, but 64-bit fields are only
32 * 32-bit-aligned. Also, on Siena we must copy to the MC shared
33 * memory strictly 32 bits at a time, so add any necessary padding.
34 */
35#define MCDI_DECLARE_BUF(_name, _len) \
36 efx_dword_t _name[DIV_ROUND_UP(_len, 4)]
37#define MCDI_DECLARE_BUF_OUT_OR_ERR(_name, _len) \
38 MCDI_DECLARE_BUF(_name, max_t(size_t, _len, 8))
39#define _MCDI_PTR(_buf, _offset) \
40 ((u8 *)(_buf) + (_offset))
41#define MCDI_PTR(_buf, _field) \
42 _MCDI_PTR(_buf, MC_CMD_ ## _field ## _OFST)
43#define _MCDI_CHECK_ALIGN(_ofst, _align) \
44 ((_ofst) + BUILD_BUG_ON_ZERO((_ofst) & (_align - 1)))
45#define _MCDI_DWORD(_buf, _field) \
46 ((_buf) + (_MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, 4) >> 2))
47
48#define MCDI_WORD(_buf, _field) \
49 ((u16)BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
50 le16_to_cpu(*(__force const __le16 *)MCDI_PTR(_buf, _field)))
51#define MCDI_SET_DWORD(_buf, _field, _value) \
52 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0, _value)
53#define MCDI_DWORD(_buf, _field) \
54 EFX_DWORD_FIELD(*_MCDI_DWORD(_buf, _field), EFX_DWORD_0)
55#define MCDI_POPULATE_DWORD_1(_buf, _field, _name1, _value1) \
56 EFX_POPULATE_DWORD_1(*_MCDI_DWORD(_buf, _field), \
57 MC_CMD_ ## _name1, _value1)
58#define MCDI_POPULATE_DWORD_2(_buf, _field, _name1, _value1, \
59 _name2, _value2) \
60 EFX_POPULATE_DWORD_2(*_MCDI_DWORD(_buf, _field), \
61 MC_CMD_ ## _name1, _value1, \
62 MC_CMD_ ## _name2, _value2)
63#define MCDI_POPULATE_DWORD_3(_buf, _field, _name1, _value1, \
64 _name2, _value2, _name3, _value3) \
65 EFX_POPULATE_DWORD_3(*_MCDI_DWORD(_buf, _field), \
66 MC_CMD_ ## _name1, _value1, \
67 MC_CMD_ ## _name2, _value2, \
68 MC_CMD_ ## _name3, _value3)
69#define MCDI_POPULATE_DWORD_4(_buf, _field, _name1, _value1, \
70 _name2, _value2, _name3, _value3, \
71 _name4, _value4) \
72 EFX_POPULATE_DWORD_4(*_MCDI_DWORD(_buf, _field), \
73 MC_CMD_ ## _name1, _value1, \
74 MC_CMD_ ## _name2, _value2, \
75 MC_CMD_ ## _name3, _value3, \
76 MC_CMD_ ## _name4, _value4)
77#define MCDI_POPULATE_DWORD_5(_buf, _field, _name1, _value1, \
78 _name2, _value2, _name3, _value3, \
79 _name4, _value4, _name5, _value5) \
80 EFX_POPULATE_DWORD_5(*_MCDI_DWORD(_buf, _field), \
81 MC_CMD_ ## _name1, _value1, \
82 MC_CMD_ ## _name2, _value2, \
83 MC_CMD_ ## _name3, _value3, \
84 MC_CMD_ ## _name4, _value4, \
85 MC_CMD_ ## _name5, _value5)
86#define MCDI_POPULATE_DWORD_6(_buf, _field, _name1, _value1, \
87 _name2, _value2, _name3, _value3, \
88 _name4, _value4, _name5, _value5, \
89 _name6, _value6) \
90 EFX_POPULATE_DWORD_6(*_MCDI_DWORD(_buf, _field), \
91 MC_CMD_ ## _name1, _value1, \
92 MC_CMD_ ## _name2, _value2, \
93 MC_CMD_ ## _name3, _value3, \
94 MC_CMD_ ## _name4, _value4, \
95 MC_CMD_ ## _name5, _value5, \
96 MC_CMD_ ## _name6, _value6)
97#define MCDI_POPULATE_DWORD_7(_buf, _field, _name1, _value1, \
98 _name2, _value2, _name3, _value3, \
99 _name4, _value4, _name5, _value5, \
100 _name6, _value6, _name7, _value7) \
101 EFX_POPULATE_DWORD_7(*_MCDI_DWORD(_buf, _field), \
102 MC_CMD_ ## _name1, _value1, \
103 MC_CMD_ ## _name2, _value2, \
104 MC_CMD_ ## _name3, _value3, \
105 MC_CMD_ ## _name4, _value4, \
106 MC_CMD_ ## _name5, _value5, \
107 MC_CMD_ ## _name6, _value6, \
108 MC_CMD_ ## _name7, _value7)
109#define MCDI_SET_QWORD(_buf, _field, _value) \
110 do { \
111 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[0], \
112 EFX_DWORD_0, (u32)(_value)); \
113 EFX_POPULATE_DWORD_1(_MCDI_DWORD(_buf, _field)[1], \
114 EFX_DWORD_0, (u64)(_value) >> 32); \
115 } while (0)
116#define MCDI_QWORD(_buf, _field) \
117 (EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[0], EFX_DWORD_0) | \
118 (u64)EFX_DWORD_FIELD(_MCDI_DWORD(_buf, _field)[1], EFX_DWORD_0) << 32)
119#define MCDI_FIELD(_ptr, _type, _field) \
120 EFX_EXTRACT_DWORD( \
121 *(efx_dword_t *) \
122 _MCDI_PTR(_ptr, MC_CMD_ ## _type ## _ ## _field ## _OFST & ~3),\
123 MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f, \
124 (MC_CMD_ ## _type ## _ ## _field ## _LBN & 0x1f) + \
125 MC_CMD_ ## _type ## _ ## _field ## _WIDTH - 1)
126
127#define _MCDI_ARRAY_PTR(_buf, _field, _index, _align) \
128 (_MCDI_PTR(_buf, _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _OFST, _align))\
129 + (_index) * _MCDI_CHECK_ALIGN(MC_CMD_ ## _field ## _LEN, _align))
130#define MCDI_DECLARE_STRUCT_PTR(_name) \
131 efx_dword_t *_name
132#define MCDI_ARRAY_STRUCT_PTR(_buf, _field, _index) \
133 ((efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
134#define MCDI_VAR_ARRAY_LEN(_len, _field) \
135 min_t(size_t, MC_CMD_ ## _field ## _MAXNUM, \
136 ((_len) - MC_CMD_ ## _field ## _OFST) / MC_CMD_ ## _field ## _LEN)
137#define MCDI_ARRAY_WORD(_buf, _field, _index) \
138 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 2) + \
139 le16_to_cpu(*(__force const __le16 *) \
140 _MCDI_ARRAY_PTR(_buf, _field, _index, 2)))
141#define _MCDI_ARRAY_DWORD(_buf, _field, _index) \
142 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 4) + \
143 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
144#define MCDI_SET_ARRAY_DWORD(_buf, _field, _index, _value) \
145 EFX_SET_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), \
146 EFX_DWORD_0, _value)
147#define MCDI_ARRAY_DWORD(_buf, _field, _index) \
148 EFX_DWORD_FIELD(*_MCDI_ARRAY_DWORD(_buf, _field, _index), EFX_DWORD_0)
149#define _MCDI_ARRAY_QWORD(_buf, _field, _index) \
150 (BUILD_BUG_ON_ZERO(MC_CMD_ ## _field ## _LEN != 8) + \
151 (efx_dword_t *)_MCDI_ARRAY_PTR(_buf, _field, _index, 4))
152#define MCDI_SET_ARRAY_QWORD(_buf, _field, _index, _value) \
153 do { \
154 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[0],\
155 EFX_DWORD_0, (u32)(_value)); \
156 EFX_SET_DWORD_FIELD(_MCDI_ARRAY_QWORD(_buf, _field, _index)[1],\
157 EFX_DWORD_0, (u64)(_value) >> 32); \
158 } while (0)
159#define MCDI_ARRAY_FIELD(_buf, _field1, _type, _index, _field2) \
160 MCDI_FIELD(MCDI_ARRAY_STRUCT_PTR(_buf, _field1, _index), \
161 _type ## _TYPEDEF, _field2)
162
163#define MCDI_EVENT_FIELD(_ev, _field) \
164 EFX_QWORD_FIELD(_ev, MCDI_EVENT_ ## _field)
165
166#endif
FILE_LICENCE
#define FILE_LICENCE(_licence)
Declare a particular licence as applying to a file.
Definition compiler.h:896
Generated by doxygen 1.14.0