xref: /freebsd/sys/dev/ntb/ntb.c (revision 47dd1d1b619cc035b82b49a91a25544309ff95ae)
1 /*-
2  * Copyright (c) 2016-2017 Alexander Motin <mav@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/systm.h>
33 #include <sys/bus.h>
34 #include <sys/rmlock.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/sysctl.h>
38 
39 #include "ntb.h"
40 
41 devclass_t ntb_hw_devclass;
42 SYSCTL_NODE(_hw, OID_AUTO, ntb, CTLFLAG_RW, 0, "NTB sysctls");
43 
44 struct ntb_child {
45 	device_t	dev;
46 	int		function;
47 	int		enabled;
48 	int		mwoff;
49 	int		mwcnt;
50 	int		spadoff;
51 	int		spadcnt;
52 	int		dboff;
53 	int		dbcnt;
54 	uint64_t	dbmask;
55 	void		*ctx;
56 	const struct ntb_ctx_ops *ctx_ops;
57 	struct rmlock	ctx_lock;
58 	struct ntb_child *next;
59 };
60 
61 int
62 ntb_register_device(device_t dev)
63 {
64 	struct ntb_child **cpp = device_get_softc(dev);
65 	struct ntb_child *nc;
66 	int i, mw, mwu, mwt, spad, spadu, spadt, db, dbu, dbt;
67 	char cfg[128] = "";
68 	char buf[32];
69 	char *n, *np, *c, *p, *name;
70 
71 	mwu = 0;
72 	mwt = NTB_MW_COUNT(dev);
73 	spadu = 0;
74 	spadt = NTB_SPAD_COUNT(dev);
75 	dbu = 0;
76 	dbt = flsll(NTB_DB_VALID_MASK(dev));
77 
78 	device_printf(dev, "%d memory windows, %d scratchpads, "
79 	    "%d doorbells\n", mwt, spadt, dbt);
80 
81 	snprintf(buf, sizeof(buf), "hint.%s.%d.config", device_get_name(dev),
82 	    device_get_unit(dev));
83 	TUNABLE_STR_FETCH(buf, cfg, sizeof(cfg));
84 	n = cfg;
85 	i = 0;
86 	while ((c = strsep(&n, ",")) != NULL) {
87 		np = c;
88 		name = strsep(&np, ":");
89 		if (name != NULL && name[0] == 0)
90 			name = NULL;
91 		p = strsep(&np, ":");
92 		mw = (p && p[0] != 0) ? strtol(p, NULL, 10) : mwt - mwu;
93 		p = strsep(&np, ":");
94 		spad = (p && p[0] != 0) ? strtol(p, NULL, 10) : spadt - spadu;
95 		db = (np && np[0] != 0) ? strtol(np, NULL, 10) : dbt - dbu;
96 
97 		if (mw > mwt - mwu || spad > spadt - spadu || db > dbt - dbu) {
98 			device_printf(dev, "Not enough resources for config\n");
99 			break;
100 		}
101 
102 		nc = malloc(sizeof(*nc), M_DEVBUF, M_WAITOK | M_ZERO);
103 		nc->function = i;
104 		nc->mwoff = mwu;
105 		nc->mwcnt = mw;
106 		nc->spadoff = spadu;
107 		nc->spadcnt = spad;
108 		nc->dboff = dbu;
109 		nc->dbcnt = db;
110 		nc->dbmask = (db == 0) ? 0 : (0xffffffffffffffff >> (64 - db));
111 		rm_init(&nc->ctx_lock, "ntb ctx");
112 		nc->dev = device_add_child(dev, name, -1);
113 		if (nc->dev == NULL) {
114 			ntb_unregister_device(dev);
115 			return (ENOMEM);
116 		}
117 		device_set_ivars(nc->dev, nc);
118 		*cpp = nc;
119 		cpp = &nc->next;
120 
121 		if (bootverbose) {
122 			device_printf(dev, "%d \"%s\":", i, name);
123 			if (mw > 0) {
124 				printf(" memory windows %d", mwu);
125 				if (mw > 1)
126 					printf("-%d", mwu + mw - 1);
127 			}
128 			if (spad > 0) {
129 				printf(" scratchpads %d", spadu);
130 				if (spad > 1)
131 					printf("-%d", spadu + spad - 1);
132 			}
133 			if (db > 0) {
134 				printf(" doorbells %d", dbu);
135 				if (db > 1)
136 					printf("-%d", dbu + db - 1);
137 			}
138 			printf("\n");
139 		}
140 
141 		mwu += mw;
142 		spadu += spad;
143 		dbu += db;
144 		i++;
145 	}
146 
147 	bus_generic_attach(dev);
148 	return (0);
149 }
150 
151 int
152 ntb_unregister_device(device_t dev)
153 {
154 	struct ntb_child **cpp = device_get_softc(dev);
155 	struct ntb_child *nc;
156 	int error = 0;
157 
158 	while ((nc = *cpp) != NULL) {
159 		*cpp = (*cpp)->next;
160 		error = device_delete_child(dev, nc->dev);
161 		if (error)
162 			break;
163 		rm_destroy(&nc->ctx_lock);
164 		free(nc, M_DEVBUF);
165 	}
166 	return (error);
167 }
168 
169 int
170 ntb_child_location_str(device_t dev, device_t child, char *buf,
171     size_t buflen)
172 {
173 	struct ntb_child *nc = device_get_ivars(child);
174 
175 	snprintf(buf, buflen, "function=%d", nc->function);
176 	return (0);
177 }
178 
179 int
180 ntb_print_child(device_t dev, device_t child)
181 {
182 	struct ntb_child *nc = device_get_ivars(child);
183 	int retval;
184 
185 	retval = bus_print_child_header(dev, child);
186 	if (nc->mwcnt > 0) {
187 		printf(" mw %d", nc->mwoff);
188 		if (nc->mwcnt > 1)
189 			printf("-%d", nc->mwoff + nc->mwcnt - 1);
190 	}
191 	if (nc->spadcnt > 0) {
192 		printf(" spad %d", nc->spadoff);
193 		if (nc->spadcnt > 1)
194 			printf("-%d", nc->spadoff + nc->spadcnt - 1);
195 	}
196 	if (nc->dbcnt > 0) {
197 		printf(" db %d", nc->dboff);
198 		if (nc->dbcnt > 1)
199 			printf("-%d", nc->dboff + nc->dbcnt - 1);
200 	}
201 	retval += printf(" at function %d", nc->function);
202 	retval += bus_print_child_domain(dev, child);
203 	retval += bus_print_child_footer(dev, child);
204 
205 	return (retval);
206 }
207 
208 void
209 ntb_link_event(device_t dev)
210 {
211 	struct ntb_child **cpp = device_get_softc(dev);
212 	struct ntb_child *nc;
213 	struct rm_priotracker ctx_tracker;
214 	enum ntb_speed speed;
215 	enum ntb_width width;
216 
217 	if (NTB_LINK_IS_UP(dev, &speed, &width)) {
218 		device_printf(dev, "Link is up (PCIe %d.x / x%d)\n",
219 		    (int)speed, (int)width);
220 	} else {
221 		device_printf(dev, "Link is down\n");
222 	}
223 	for (nc = *cpp; nc != NULL; nc = nc->next) {
224 		rm_rlock(&nc->ctx_lock, &ctx_tracker);
225 		if (nc->ctx_ops != NULL && nc->ctx_ops->link_event != NULL)
226 			nc->ctx_ops->link_event(nc->ctx);
227 		rm_runlock(&nc->ctx_lock, &ctx_tracker);
228 	}
229 }
230 
231 void
232 ntb_db_event(device_t dev, uint32_t vec)
233 {
234 	struct ntb_child **cpp = device_get_softc(dev);
235 	struct ntb_child *nc;
236 	struct rm_priotracker ctx_tracker;
237 
238 	for (nc = *cpp; nc != NULL; nc = nc->next) {
239 		rm_rlock(&nc->ctx_lock, &ctx_tracker);
240 		if (nc->ctx_ops != NULL && nc->ctx_ops->db_event != NULL)
241 			nc->ctx_ops->db_event(nc->ctx, vec);
242 		rm_runlock(&nc->ctx_lock, &ctx_tracker);
243 	}
244 }
245 
246 bool
247 ntb_link_is_up(device_t ntb, enum ntb_speed *speed, enum ntb_width *width)
248 {
249 
250 	return (NTB_LINK_IS_UP(device_get_parent(ntb), speed, width));
251 }
252 
253 int
254 ntb_link_enable(device_t ntb, enum ntb_speed speed, enum ntb_width width)
255 {
256 	struct ntb_child *nc = device_get_ivars(ntb);
257 	struct ntb_child **cpp = device_get_softc(device_get_parent(nc->dev));
258 	struct ntb_child *nc1;
259 
260 	for (nc1 = *cpp; nc1 != NULL; nc1 = nc1->next) {
261 		if (nc1->enabled) {
262 			nc->enabled = 1;
263 			return (0);
264 		}
265 	}
266 	nc->enabled = 1;
267 	return (NTB_LINK_ENABLE(device_get_parent(ntb), speed, width));
268 }
269 
270 int
271 ntb_link_disable(device_t ntb)
272 {
273 	struct ntb_child *nc = device_get_ivars(ntb);
274 	struct ntb_child **cpp = device_get_softc(device_get_parent(nc->dev));
275 	struct ntb_child *nc1;
276 
277 	if (!nc->enabled)
278 		return (0);
279 	nc->enabled = 0;
280 	for (nc1 = *cpp; nc1 != NULL; nc1 = nc1->next) {
281 		if (nc1->enabled)
282 			return (0);
283 	}
284 	return (NTB_LINK_DISABLE(device_get_parent(ntb)));
285 }
286 
287 bool
288 ntb_link_enabled(device_t ntb)
289 {
290 	struct ntb_child *nc = device_get_ivars(ntb);
291 
292 	return (nc->enabled && NTB_LINK_ENABLED(device_get_parent(ntb)));
293 }
294 
295 int
296 ntb_set_ctx(device_t ntb, void *ctx, const struct ntb_ctx_ops *ctx_ops)
297 {
298 	struct ntb_child *nc = device_get_ivars(ntb);
299 
300 	if (ctx == NULL || ctx_ops == NULL)
301 		return (EINVAL);
302 
303 	rm_wlock(&nc->ctx_lock);
304 	if (nc->ctx_ops != NULL) {
305 		rm_wunlock(&nc->ctx_lock);
306 		return (EINVAL);
307 	}
308 	nc->ctx = ctx;
309 	nc->ctx_ops = ctx_ops;
310 
311 	/*
312 	 * If applicaiton driver asks for link events, generate fake one now
313 	 * to let it update link state without races while we hold the lock.
314 	 */
315 	if (ctx_ops->link_event != NULL)
316 		ctx_ops->link_event(ctx);
317 	rm_wunlock(&nc->ctx_lock);
318 
319 	return (0);
320 }
321 
322 void *
323 ntb_get_ctx(device_t ntb, const struct ntb_ctx_ops **ctx_ops)
324 {
325 	struct ntb_child *nc = device_get_ivars(ntb);
326 
327 	KASSERT(nc->ctx != NULL && nc->ctx_ops != NULL, ("bogus"));
328 	if (ctx_ops != NULL)
329 		*ctx_ops = nc->ctx_ops;
330 	return (nc->ctx);
331 }
332 
333 void
334 ntb_clear_ctx(device_t ntb)
335 {
336 	struct ntb_child *nc = device_get_ivars(ntb);
337 
338 	rm_wlock(&nc->ctx_lock);
339 	nc->ctx = NULL;
340 	nc->ctx_ops = NULL;
341 	rm_wunlock(&nc->ctx_lock);
342 }
343 
344 uint8_t
345 ntb_mw_count(device_t ntb)
346 {
347 	struct ntb_child *nc = device_get_ivars(ntb);
348 
349 	return (nc->mwcnt);
350 }
351 
352 int
353 ntb_mw_get_range(device_t ntb, unsigned mw_idx, vm_paddr_t *base,
354     caddr_t *vbase, size_t *size, size_t *align, size_t *align_size,
355     bus_addr_t *plimit)
356 {
357 	struct ntb_child *nc = device_get_ivars(ntb);
358 
359 	return (NTB_MW_GET_RANGE(device_get_parent(ntb), mw_idx + nc->mwoff,
360 	    base, vbase, size, align, align_size, plimit));
361 }
362 
363 int
364 ntb_mw_set_trans(device_t ntb, unsigned mw_idx, bus_addr_t addr, size_t size)
365 {
366 	struct ntb_child *nc = device_get_ivars(ntb);
367 
368 	return (NTB_MW_SET_TRANS(device_get_parent(ntb), mw_idx + nc->mwoff,
369 	    addr, size));
370 }
371 
372 int
373 ntb_mw_clear_trans(device_t ntb, unsigned mw_idx)
374 {
375 	struct ntb_child *nc = device_get_ivars(ntb);
376 
377 	return (NTB_MW_CLEAR_TRANS(device_get_parent(ntb), mw_idx + nc->mwoff));
378 }
379 
380 int
381 ntb_mw_get_wc(device_t ntb, unsigned mw_idx, vm_memattr_t *mode)
382 {
383 	struct ntb_child *nc = device_get_ivars(ntb);
384 
385 	return (NTB_MW_GET_WC(device_get_parent(ntb), mw_idx + nc->mwoff, mode));
386 }
387 
388 int
389 ntb_mw_set_wc(device_t ntb, unsigned mw_idx, vm_memattr_t mode)
390 {
391 	struct ntb_child *nc = device_get_ivars(ntb);
392 
393 	return (NTB_MW_SET_WC(device_get_parent(ntb), mw_idx + nc->mwoff, mode));
394 }
395 
396 uint8_t
397 ntb_spad_count(device_t ntb)
398 {
399 	struct ntb_child *nc = device_get_ivars(ntb);
400 
401 	return (nc->spadcnt);
402 }
403 
404 void
405 ntb_spad_clear(device_t ntb)
406 {
407 	struct ntb_child *nc = device_get_ivars(ntb);
408 	unsigned i;
409 
410 	for (i = 0; i < nc->spadcnt; i++)
411 		NTB_SPAD_WRITE(device_get_parent(ntb), i + nc->spadoff, 0);
412 }
413 
414 int
415 ntb_spad_write(device_t ntb, unsigned int idx, uint32_t val)
416 {
417 	struct ntb_child *nc = device_get_ivars(ntb);
418 
419 	return (NTB_SPAD_WRITE(device_get_parent(ntb), idx + nc->spadoff, val));
420 }
421 
422 int
423 ntb_spad_read(device_t ntb, unsigned int idx, uint32_t *val)
424 {
425 	struct ntb_child *nc = device_get_ivars(ntb);
426 
427 	return (NTB_SPAD_READ(device_get_parent(ntb), idx + nc->spadoff, val));
428 }
429 
430 int
431 ntb_peer_spad_write(device_t ntb, unsigned int idx, uint32_t val)
432 {
433 	struct ntb_child *nc = device_get_ivars(ntb);
434 
435 	return (NTB_PEER_SPAD_WRITE(device_get_parent(ntb), idx + nc->spadoff,
436 	    val));
437 }
438 
439 int
440 ntb_peer_spad_read(device_t ntb, unsigned int idx, uint32_t *val)
441 {
442 	struct ntb_child *nc = device_get_ivars(ntb);
443 
444 	return (NTB_PEER_SPAD_READ(device_get_parent(ntb), idx + nc->spadoff,
445 	    val));
446 }
447 
448 uint64_t
449 ntb_db_valid_mask(device_t ntb)
450 {
451 	struct ntb_child *nc = device_get_ivars(ntb);
452 
453 	return (nc->dbmask);
454 }
455 
456 int
457 ntb_db_vector_count(device_t ntb)
458 {
459 
460 	return (NTB_DB_VECTOR_COUNT(device_get_parent(ntb)));
461 }
462 
463 uint64_t
464 ntb_db_vector_mask(device_t ntb, uint32_t vector)
465 {
466 	struct ntb_child *nc = device_get_ivars(ntb);
467 
468 	return ((NTB_DB_VECTOR_MASK(device_get_parent(ntb), vector)
469 	    >> nc->dboff) & nc->dbmask);
470 }
471 
472 int
473 ntb_peer_db_addr(device_t ntb, bus_addr_t *db_addr, vm_size_t *db_size)
474 {
475 
476 	return (NTB_PEER_DB_ADDR(device_get_parent(ntb), db_addr, db_size));
477 }
478 
479 void
480 ntb_db_clear(device_t ntb, uint64_t bits)
481 {
482 	struct ntb_child *nc = device_get_ivars(ntb);
483 
484 	return (NTB_DB_CLEAR(device_get_parent(ntb), bits << nc->dboff));
485 }
486 
487 void
488 ntb_db_clear_mask(device_t ntb, uint64_t bits)
489 {
490 	struct ntb_child *nc = device_get_ivars(ntb);
491 
492 	return (NTB_DB_CLEAR_MASK(device_get_parent(ntb), bits << nc->dboff));
493 }
494 
495 uint64_t
496 ntb_db_read(device_t ntb)
497 {
498 	struct ntb_child *nc = device_get_ivars(ntb);
499 
500 	return ((NTB_DB_READ(device_get_parent(ntb)) >> nc->dboff)
501 	    & nc->dbmask);
502 }
503 
504 void
505 ntb_db_set_mask(device_t ntb, uint64_t bits)
506 {
507 	struct ntb_child *nc = device_get_ivars(ntb);
508 
509 	return (NTB_DB_SET_MASK(device_get_parent(ntb), bits << nc->dboff));
510 }
511 
512 void
513 ntb_peer_db_set(device_t ntb, uint64_t bits)
514 {
515 	struct ntb_child *nc = device_get_ivars(ntb);
516 
517 	return (NTB_PEER_DB_SET(device_get_parent(ntb), bits << nc->dboff));
518 }
519 
520 MODULE_VERSION(ntb, 1);
521