2 * Copyright (C) 2015-2017 Netronome Systems, Inc.
4 * This software is dual licensed under the GNU General License Version 2,
5 * June 1991 as shown in the file COPYING in the top-level directory of this
6 * source tree or the BSD 2-Clause License provided below. You have the
7 * option to license this software under the complete terms of either license.
9 * The BSD 2-Clause License:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * 1. Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
19 * 2. Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36 * Author: Jakub Kicinski <jakub.kicinski@netronome.com>
37 * Jason McMullan <jason.mcmullan@netronome.com>
39 #include <linux/delay.h>
40 #include <linux/kernel.h>
41 #include <linux/slab.h>
46 #include "nfp6000/nfp6000.h"
48 #define NFP_RESOURCE_TBL_TARGET NFP_CPP_TARGET_MU
49 #define NFP_RESOURCE_TBL_BASE 0x8100000000ULL
51 /* NFP Resource Table self-identifier */
52 #define NFP_RESOURCE_TBL_NAME "nfp.res"
53 #define NFP_RESOURCE_TBL_KEY 0x00000000 /* Special key for entry 0 */
55 #define NFP_RESOURCE_ENTRY_NAME_SZ 8
58 * struct nfp_resource_entry - Resource table entry
59 * @owner: NFP CPP Lock, interface owner
60 * @key: NFP CPP Lock, posix_crc32(name, 8)
61 * @region: Memory region descriptor
62 * @name: ASCII, zero padded name
64 * @cpp_action: CPP Action
65 * @cpp_token: CPP Token
66 * @cpp_target: CPP Target ID
67 * @page_offset: 256-byte page offset into target's CPP address
68 * @page_size: size, in 256-byte pages
70 struct nfp_resource_entry {
71 struct nfp_resource_entry_mutex {
75 struct nfp_resource_entry_region {
76 u8 name[NFP_RESOURCE_ENTRY_NAME_SZ];
86 #define NFP_RESOURCE_TBL_SIZE 4096
87 #define NFP_RESOURCE_TBL_ENTRIES (NFP_RESOURCE_TBL_SIZE / \
88 sizeof(struct nfp_resource_entry))
91 char name[NFP_RESOURCE_ENTRY_NAME_SZ + 1];
95 struct nfp_cpp_mutex *mutex;
98 static int nfp_cpp_resource_find(struct nfp_cpp *cpp, struct nfp_resource *res)
100 char name_pad[NFP_RESOURCE_ENTRY_NAME_SZ] = {};
101 struct nfp_resource_entry entry;
105 cpp_id = NFP_CPP_ID(NFP_RESOURCE_TBL_TARGET, 3, 0); /* Atomic read */
107 strncpy(name_pad, res->name, sizeof(name_pad));
109 /* Search for a matching entry */
110 if (!memcmp(name_pad, NFP_RESOURCE_TBL_NAME "\0\0\0\0\0\0\0\0", 8)) {
111 nfp_err(cpp, "Grabbing device lock not supported\n");
114 key = crc32_posix(name_pad, sizeof(name_pad));
116 for (i = 0; i < NFP_RESOURCE_TBL_ENTRIES; i++) {
117 u64 addr = NFP_RESOURCE_TBL_BASE +
118 sizeof(struct nfp_resource_entry) * i;
120 ret = nfp_cpp_read(cpp, cpp_id, addr, &entry, sizeof(entry));
121 if (ret != sizeof(entry))
124 if (entry.mutex.key != key)
129 nfp_cpp_mutex_alloc(cpp,
130 NFP_RESOURCE_TBL_TARGET, addr, key);
131 res->cpp_id = NFP_CPP_ID(entry.region.cpp_target,
132 entry.region.cpp_action,
133 entry.region.cpp_token);
134 res->addr = (u64)entry.region.page_offset << 8;
135 res->size = (u64)entry.region.page_size << 8;
144 nfp_resource_try_acquire(struct nfp_cpp *cpp, struct nfp_resource *res,
145 struct nfp_cpp_mutex *dev_mutex)
149 if (nfp_cpp_mutex_lock(dev_mutex))
152 err = nfp_cpp_resource_find(cpp, res);
156 err = nfp_cpp_mutex_trylock(res->mutex);
158 goto err_res_mutex_free;
160 nfp_cpp_mutex_unlock(dev_mutex);
165 nfp_cpp_mutex_free(res->mutex);
167 nfp_cpp_mutex_unlock(dev_mutex);
173 * nfp_resource_acquire() - Acquire a resource handle
174 * @cpp: NFP CPP handle
175 * @name: Name of the resource
177 * NOTE: This function locks the acquired resource
179 * Return: NFP Resource handle, or ERR_PTR()
181 struct nfp_resource *
182 nfp_resource_acquire(struct nfp_cpp *cpp, const char *name)
184 unsigned long warn_at = jiffies + NFP_MUTEX_WAIT_FIRST_WARN * HZ;
185 unsigned long err_at = jiffies + NFP_MUTEX_WAIT_ERROR * HZ;
186 struct nfp_cpp_mutex *dev_mutex;
187 struct nfp_resource *res;
190 res = kzalloc(sizeof(*res), GFP_KERNEL);
192 return ERR_PTR(-ENOMEM);
194 strncpy(res->name, name, NFP_RESOURCE_ENTRY_NAME_SZ);
196 dev_mutex = nfp_cpp_mutex_alloc(cpp, NFP_RESOURCE_TBL_TARGET,
197 NFP_RESOURCE_TBL_BASE,
198 NFP_RESOURCE_TBL_KEY);
201 return ERR_PTR(-ENOMEM);
205 err = nfp_resource_try_acquire(cpp, res, dev_mutex);
211 err = msleep_interruptible(1);
217 if (time_is_before_eq_jiffies(warn_at)) {
218 warn_at = jiffies + NFP_MUTEX_WAIT_NEXT_WARN * HZ;
219 nfp_warn(cpp, "Warning: waiting for NFP resource %s\n",
222 if (time_is_before_eq_jiffies(err_at)) {
223 nfp_err(cpp, "Error: resource %s timed out\n", name);
229 nfp_cpp_mutex_free(dev_mutex);
234 nfp_cpp_mutex_free(dev_mutex);
240 * nfp_resource_release() - Release a NFP Resource handle
241 * @res: NFP Resource handle
243 * NOTE: This function implictly unlocks the resource handle
245 void nfp_resource_release(struct nfp_resource *res)
247 nfp_cpp_mutex_unlock(res->mutex);
248 nfp_cpp_mutex_free(res->mutex);
253 * nfp_resource_wait() - Wait for resource to appear
254 * @cpp: NFP CPP handle
255 * @name: Name of the resource
256 * @secs: Number of seconds to wait
258 * Wait for resource to appear in the resource table, grab and release
259 * its lock. The wait is jiffies-based, don't expect fine granularity.
261 * Return: 0 on success, errno otherwise.
263 int nfp_resource_wait(struct nfp_cpp *cpp, const char *name, unsigned int secs)
265 unsigned long warn_at = jiffies + NFP_MUTEX_WAIT_FIRST_WARN * HZ;
266 unsigned long err_at = jiffies + secs * HZ;
267 struct nfp_resource *res;
270 res = nfp_resource_acquire(cpp, name);
272 nfp_resource_release(res);
276 if (PTR_ERR(res) != -ENOENT) {
277 nfp_err(cpp, "error waiting for resource %s: %ld\n",
281 if (time_is_before_eq_jiffies(err_at)) {
282 nfp_err(cpp, "timeout waiting for resource %s\n", name);
285 if (time_is_before_eq_jiffies(warn_at)) {
286 warn_at = jiffies + NFP_MUTEX_WAIT_NEXT_WARN * HZ;
287 nfp_info(cpp, "waiting for NFP resource %s\n", name);
289 if (msleep_interruptible(10)) {
290 nfp_err(cpp, "wait for resource %s interrupted\n",
298 * nfp_resource_cpp_id() - Return the cpp_id of a resource handle
299 * @res: NFP Resource handle
303 u32 nfp_resource_cpp_id(struct nfp_resource *res)
309 * nfp_resource_name() - Return the name of a resource handle
310 * @res: NFP Resource handle
312 * Return: const char pointer to the name of the resource
314 const char *nfp_resource_name(struct nfp_resource *res)
320 * nfp_resource_address() - Return the address of a resource handle
321 * @res: NFP Resource handle
323 * Return: Address of the resource
325 u64 nfp_resource_address(struct nfp_resource *res)
331 * nfp_resource_size() - Return the size in bytes of a resource handle
332 * @res: NFP Resource handle
334 * Return: Size of the resource in bytes
336 u64 nfp_resource_size(struct nfp_resource *res)