1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Netronome Systems, Inc.
6 #define NFP_SUBSYS "nfp_nsp"
11 #include <rte_common.h>
15 #include "nfp_resource.h"
18 nfp_nsp_config_modified(struct nfp_nsp *state)
20 return state->modified;
24 nfp_nsp_config_set_modified(struct nfp_nsp *state, int modified)
26 state->modified = modified;
30 nfp_nsp_config_entries(struct nfp_nsp *state)
32 return state->entries;
36 nfp_nsp_config_idx(struct nfp_nsp *state)
42 nfp_nsp_config_set_state(struct nfp_nsp *state, void *entries, unsigned int idx)
44 state->entries = entries;
49 nfp_nsp_config_clear_state(struct nfp_nsp *state)
51 state->entries = NULL;
56 nfp_nsp_print_extended_error(uint32_t ret_val)
63 for (i = 0; i < (int)ARRAY_SIZE(nsp_errors); i++)
64 if (ret_val == (uint32_t)nsp_errors[i].code)
65 printf("err msg: %s\n", nsp_errors[i].msg);
69 nfp_nsp_check(struct nfp_nsp *state)
71 struct nfp_cpp *cpp = state->cpp;
72 uint64_t nsp_status, reg;
76 nsp_cpp = nfp_resource_cpp_id(state->res);
77 nsp_status = nfp_resource_address(state->res) + NSP_STATUS;
79 err = nfp_cpp_readq(cpp, nsp_cpp, nsp_status, ®);
83 if (FIELD_GET(NSP_STATUS_MAGIC, reg) != NSP_MAGIC) {
84 printf("Cannot detect NFP Service Processor\n");
88 state->ver.major = FIELD_GET(NSP_STATUS_MAJOR, reg);
89 state->ver.minor = FIELD_GET(NSP_STATUS_MINOR, reg);
91 if (state->ver.major != NSP_MAJOR || state->ver.minor < NSP_MINOR) {
92 printf("Unsupported ABI %hu.%hu\n", state->ver.major,
97 if (reg & NSP_STATUS_BUSY) {
98 printf("Service processor busy!\n");
106 * nfp_nsp_open() - Prepare for communication and lock the NSP resource.
107 * @cpp: NFP CPP Handle
110 nfp_nsp_open(struct nfp_cpp *cpp)
112 struct nfp_resource *res;
113 struct nfp_nsp *state;
116 res = nfp_resource_acquire(cpp, NFP_RESOURCE_NSP);
120 state = malloc(sizeof(*state));
122 nfp_resource_release(res);
125 memset(state, 0, sizeof(*state));
129 err = nfp_nsp_check(state);
131 nfp_nsp_close(state);
139 * nfp_nsp_close() - Clean up and unlock the NSP resource.
140 * @state: NFP SP state
143 nfp_nsp_close(struct nfp_nsp *state)
145 nfp_resource_release(state->res);
150 nfp_nsp_get_abi_ver_major(struct nfp_nsp *state)
152 return state->ver.major;
156 nfp_nsp_get_abi_ver_minor(struct nfp_nsp *state)
158 return state->ver.minor;
162 nfp_nsp_wait_reg(struct nfp_cpp *cpp, uint64_t *reg, uint32_t nsp_cpp,
163 uint64_t addr, uint64_t mask, uint64_t val)
165 struct timespec wait;
170 wait.tv_nsec = 25000000;
174 err = nfp_cpp_readq(cpp, nsp_cpp, addr, reg);
178 if ((*reg & mask) == val)
188 * nfp_nsp_command() - Execute a command on the NFP Service Processor
189 * @state: NFP SP state
190 * @code: NFP SP Command Code
191 * @option: NFP SP Command Argument
192 * @buff_cpp: NFP SP Buffer CPP Address info
193 * @buff_addr: NFP SP Buffer Host address
195 * Return: 0 for success with no result
197 * positive value for NSP completion with a result code
199 * -EAGAIN if the NSP is not yet present
200 * -ENODEV if the NSP is not a supported model
201 * -EBUSY if the NSP is stuck
202 * -EINTR if interrupted while waiting for completion
203 * -ETIMEDOUT if the NSP took longer than 30 seconds to complete
206 nfp_nsp_command(struct nfp_nsp *state, uint16_t code, uint32_t option,
207 uint32_t buff_cpp, uint64_t buff_addr)
209 uint64_t reg, ret_val, nsp_base, nsp_buffer, nsp_status, nsp_command;
210 struct nfp_cpp *cpp = state->cpp;
214 nsp_cpp = nfp_resource_cpp_id(state->res);
215 nsp_base = nfp_resource_address(state->res);
216 nsp_status = nsp_base + NSP_STATUS;
217 nsp_command = nsp_base + NSP_COMMAND;
218 nsp_buffer = nsp_base + NSP_BUFFER;
220 err = nfp_nsp_check(state);
224 if (!FIELD_FIT(NSP_BUFFER_CPP, buff_cpp >> 8) ||
225 !FIELD_FIT(NSP_BUFFER_ADDRESS, buff_addr)) {
226 printf("Host buffer out of reach %08x %" PRIx64 "\n",
227 buff_cpp, buff_addr);
231 err = nfp_cpp_writeq(cpp, nsp_cpp, nsp_buffer,
232 FIELD_PREP(NSP_BUFFER_CPP, buff_cpp >> 8) |
233 FIELD_PREP(NSP_BUFFER_ADDRESS, buff_addr));
237 err = nfp_cpp_writeq(cpp, nsp_cpp, nsp_command,
238 FIELD_PREP(NSP_COMMAND_OPTION, option) |
239 FIELD_PREP(NSP_COMMAND_CODE, code) |
240 FIELD_PREP(NSP_COMMAND_START, 1));
244 /* Wait for NSP_COMMAND_START to go to 0 */
245 err = nfp_nsp_wait_reg(cpp, ®, nsp_cpp, nsp_command,
246 NSP_COMMAND_START, 0);
248 printf("Error %d waiting for code 0x%04x to start\n",
253 /* Wait for NSP_STATUS_BUSY to go to 0 */
254 err = nfp_nsp_wait_reg(cpp, ®, nsp_cpp, nsp_status, NSP_STATUS_BUSY,
257 printf("Error %d waiting for code 0x%04x to complete\n",
262 err = nfp_cpp_readq(cpp, nsp_cpp, nsp_command, &ret_val);
265 ret_val = FIELD_GET(NSP_COMMAND_OPTION, ret_val);
267 err = FIELD_GET(NSP_STATUS_RESULT, reg);
269 printf("Result (error) code set: %d (%d) command: %d\n",
270 -err, (int)ret_val, code);
271 nfp_nsp_print_extended_error(ret_val);
278 #define SZ_1M 0x00100000
281 nfp_nsp_command_buf(struct nfp_nsp *nsp, uint16_t code, uint32_t option,
282 const void *in_buf, unsigned int in_size, void *out_buf,
283 unsigned int out_size)
285 struct nfp_cpp *cpp = nsp->cpp;
286 unsigned int max_size;
287 uint64_t reg, cpp_buf;
291 if (nsp->ver.minor < 13) {
292 printf("NSP: Code 0x%04x with buffer not supported\n", code);
293 printf("\t(ABI %hu.%hu)\n", nsp->ver.major, nsp->ver.minor);
297 err = nfp_cpp_readq(cpp, nfp_resource_cpp_id(nsp->res),
298 nfp_resource_address(nsp->res) +
299 NSP_DFLT_BUFFER_CONFIG,
304 max_size = RTE_MAX(in_size, out_size);
305 if (FIELD_GET(NSP_DFLT_BUFFER_SIZE_MB, reg) * SZ_1M < max_size) {
306 printf("NSP: default buffer too small for command 0x%04x\n",
308 printf("\t(%llu < %u)\n",
309 FIELD_GET(NSP_DFLT_BUFFER_SIZE_MB, reg) * SZ_1M,
314 err = nfp_cpp_readq(cpp, nfp_resource_cpp_id(nsp->res),
315 nfp_resource_address(nsp->res) +
321 cpp_id = FIELD_GET(NSP_BUFFER_CPP, reg) << 8;
322 cpp_buf = FIELD_GET(NSP_BUFFER_ADDRESS, reg);
324 if (in_buf && in_size) {
325 err = nfp_cpp_write(cpp, cpp_id, cpp_buf, in_buf, in_size);
329 /* Zero out remaining part of the buffer */
330 if (out_buf && out_size && out_size > in_size) {
331 memset(out_buf, 0, out_size - in_size);
332 err = nfp_cpp_write(cpp, cpp_id, cpp_buf + in_size, out_buf,
338 ret = nfp_nsp_command(nsp, code, option, cpp_id, cpp_buf);
342 if (out_buf && out_size) {
343 err = nfp_cpp_read(cpp, cpp_id, cpp_buf, out_buf, out_size);
352 nfp_nsp_wait(struct nfp_nsp *state)
354 struct timespec wait;
359 wait.tv_nsec = 25000000;
363 err = nfp_nsp_command(state, SPCODE_NOOP, 0, 0, 0);
369 if (count++ > 1000) {
375 printf("NSP failed to respond %d\n", err);
381 nfp_nsp_device_soft_reset(struct nfp_nsp *state)
383 return nfp_nsp_command(state, SPCODE_SOFT_RESET, 0, 0, 0);
387 nfp_nsp_mac_reinit(struct nfp_nsp *state)
389 return nfp_nsp_command(state, SPCODE_MAC_INIT, 0, 0, 0);
393 nfp_nsp_load_fw(struct nfp_nsp *state, void *buf, unsigned int size)
395 return nfp_nsp_command_buf(state, SPCODE_FW_LOAD, size, buf, size,
400 nfp_nsp_read_eth_table(struct nfp_nsp *state, void *buf, unsigned int size)
402 return nfp_nsp_command_buf(state, SPCODE_ETH_RESCAN, size, NULL, 0,
407 nfp_nsp_write_eth_table(struct nfp_nsp *state, const void *buf,
410 return nfp_nsp_command_buf(state, SPCODE_ETH_CONTROL, size, buf, size,
415 nfp_nsp_read_identify(struct nfp_nsp *state, void *buf, unsigned int size)
417 return nfp_nsp_command_buf(state, SPCODE_NSP_IDENTIFY, size, NULL, 0,
422 nfp_nsp_read_sensors(struct nfp_nsp *state, unsigned int sensor_mask, void *buf,
425 return nfp_nsp_command_buf(state, SPCODE_NSP_SENSORS, sensor_mask, NULL,