2 * Copyright (c) 2016 Alexander Motin <mav@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
34 extern devclass_t ntb_hw_devclass;
37 int ntb_register_device(device_t ntb);
38 int ntb_unregister_device(device_t ntb);
39 int ntb_child_location_str(device_t dev, device_t child, char *buf,
41 int ntb_print_child(device_t dev, device_t child);
44 * ntb_link_event() - notify driver context of a change in link status
45 * @ntb: NTB device context
47 * Notify the driver context that the link status may have changed. The driver
48 * should call intb_link_is_up() to get the current status.
50 void ntb_link_event(device_t ntb);
53 * ntb_db_event() - notify driver context of a doorbell event
54 * @ntb: NTB device context
55 * @vector: Interrupt vector number
57 * Notify the driver context of a doorbell event. If hardware supports
58 * multiple interrupt vectors for doorbells, the vector number indicates which
59 * vector received the interrupt. The vector number is relative to the first
60 * vector used for doorbells, starting at zero, and must be less than
61 * ntb_db_vector_count(). The driver may call ntb_db_read() to check which
62 * doorbell bits need service, and ntb_db_vector_mask() to determine which of
63 * those bits are associated with the vector number.
65 void ntb_db_event(device_t ntb, uint32_t vec);
68 * ntb_port_number() - get the local port number
69 * @ntb: NTB device context.
71 * Hardware driver returns local port number in compliance with topology.
73 * Return: the local port number
75 int ntb_port_number(device_t ntb);
78 * ntb_port_count() - get the number of peer device ports
79 * @ntb: NTB device context.
81 * By default hardware driver supports just one peer device.
83 * Return: the number of peer ports
85 int ntb_peer_port_count(device_t ntb);
88 * ntb_peer_port_number() - get the peer port by given index
89 * @ntb: NTB device context.
90 * @idx: Peer port index (should be zero for now).
92 * By default hardware driver supports just one peer device, so this method
93 * shall return the corresponding value.
95 * Return: the peer device port or an error number
97 int ntb_peer_port_number(device_t ntb, int pidx);
100 * ntb_peer_port_idx() - get the peer device port index by given port
102 * @ntb: NTB device context.
103 * @port: Peer port number
105 * By default hardware driver supports just one peer device, so given a
106 * valid peer port number, the return value shall be zero.
108 * Return: the peer port index or an error number
110 int ntb_peer_port_idx(device_t ntb, int port);
113 * ntb_link_is_up() - get the current ntb link state
114 * @ntb: NTB device context
115 * @speed: OUT - The link speed expressed as PCIe generation number
116 * @width: OUT - The link width expressed as the number of PCIe lanes
118 * RETURNS: true or false based on the hardware link state
120 bool ntb_link_is_up(device_t ntb, enum ntb_speed *speed, enum ntb_width *width);
123 * ntb_link_enable() - enable the link on the secondary side of the ntb
124 * @ntb: NTB device context
125 * @max_speed: The maximum link speed expressed as PCIe generation number[0]
126 * @max_width: The maximum link width expressed as the number of PCIe lanes[0]
128 * Enable the link on the secondary side of the ntb. This can only be done
129 * from the primary side of the ntb in primary or b2b topology. The ntb device
130 * should train the link to its maximum speed and width, or the requested speed
131 * and width, whichever is smaller, if supported.
133 * Return: Zero on success, otherwise an error number.
135 * [0]: Only NTB_SPEED_AUTO and NTB_WIDTH_AUTO are valid inputs; other speed
136 * and width input will be ignored.
138 int ntb_link_enable(device_t ntb, enum ntb_speed speed, enum ntb_width width);
141 * ntb_link_disable() - disable the link on the secondary side of the ntb
142 * @ntb: NTB device context
144 * Disable the link on the secondary side of the ntb. This can only be done
145 * from the primary side of the ntb in primary or b2b topology. The ntb device
146 * should disable the link. Returning from this call must indicate that a
147 * barrier has passed, though with no more writes may pass in either direction
148 * across the link, except if this call returns an error number.
150 * Return: Zero on success, otherwise an error number.
152 int ntb_link_disable(device_t ntb);
155 * get enable status of the link on the secondary side of the ntb
157 bool ntb_link_enabled(device_t ntb);
160 * ntb_set_ctx() - associate a driver context with an ntb device
161 * @ntb: NTB device context
162 * @ctx: Driver context
163 * @ctx_ops: Driver context operations
165 * Associate a driver context and operations with a ntb device. The context is
166 * provided by the client driver, and the driver may associate a different
167 * context with each ntb device.
169 * Return: Zero if the context is associated, otherwise an error number.
171 int ntb_set_ctx(device_t ntb, void *ctx, const struct ntb_ctx_ops *ctx_ops);
174 * ntb_set_ctx() - get a driver context associated with an ntb device
175 * @ntb: NTB device context
176 * @ctx_ops: Driver context operations
178 * Get a driver context and operations associated with a ntb device.
180 void * ntb_get_ctx(device_t ntb, const struct ntb_ctx_ops **ctx_ops);
183 * ntb_clear_ctx() - disassociate any driver context from an ntb device
184 * @ntb: NTB device context
186 * Clear any association that may exist between a driver context and the ntb
189 void ntb_clear_ctx(device_t ntb);
192 * ntb_mw_count() - Get the number of memory windows available for KPI
195 * (Excludes any MW wholly reserved for register access.)
197 uint8_t ntb_mw_count(device_t ntb);
200 * ntb_mw_get_range() - get the range of a memory window
201 * @ntb: NTB device context
202 * @idx: Memory window number
203 * @base: OUT - the base address for mapping the memory window
204 * @size: OUT - the size for mapping the memory window
205 * @align: OUT - the base alignment for translating the memory window
206 * @align_size: OUT - the size alignment for translating the memory window
208 * Get the range of a memory window. NULL may be given for any output
209 * parameter if the value is not needed. The base and size may be used for
210 * mapping the memory window, to access the peer memory. The alignment and
211 * size may be used for translating the memory window, for the peer to access
212 * memory on the local system.
214 * Return: Zero on success, otherwise an error number.
216 int ntb_mw_get_range(device_t ntb, unsigned mw_idx, vm_paddr_t *base,
217 caddr_t *vbase, size_t *size, size_t *align, size_t *align_size,
221 * ntb_mw_set_trans() - set the translation of a memory window
222 * @ntb: NTB device context
223 * @idx: Memory window number
224 * @addr: The dma address local memory to expose to the peer
225 * @size: The size of the local memory to expose to the peer
227 * Set the translation of a memory window. The peer may access local memory
228 * through the window starting at the address, up to the size. The address
229 * must be aligned to the alignment specified by ntb_mw_get_range(). The size
230 * must be aligned to the size alignment specified by ntb_mw_get_range(). The
231 * address must be below the plimit specified by ntb_mw_get_range() (i.e. for
234 * Return: Zero on success, otherwise an error number.
236 int ntb_mw_set_trans(device_t ntb, unsigned mw_idx, bus_addr_t addr,
240 * ntb_mw_clear_trans() - clear the translation of a memory window
241 * @ntb: NTB device context
242 * @idx: Memory window number
244 * Clear the translation of a memory window. The peer may no longer access
245 * local memory through the window.
247 * Return: Zero on success, otherwise an error number.
249 int ntb_mw_clear_trans(device_t ntb, unsigned mw_idx);
252 * ntb_mw_get_wc - Get the write-combine status of a memory window
254 * Returns: Zero on success, setting *wc; otherwise an error number (e.g. if
255 * idx is an invalid memory window).
257 * Mode is a VM_MEMATTR_* type.
259 int ntb_mw_get_wc(device_t ntb, unsigned mw_idx, vm_memattr_t *mode);
262 * ntb_mw_set_wc - Set the write-combine status of a memory window
264 * If 'mode' matches the current status, this does nothing and succeeds. Mode
265 * is a VM_MEMATTR_* type.
267 * Returns: Zero on success, setting the caching attribute on the virtual
268 * mapping of the BAR; otherwise an error number (e.g. if idx is an invalid
269 * memory window, or if changing the caching attribute fails).
271 int ntb_mw_set_wc(device_t ntb, unsigned mw_idx, vm_memattr_t mode);
274 * ntb_spad_count() - get the total scratch regs usable
275 * @ntb: pointer to ntb_softc instance
277 * This function returns the max 32bit scratchpad registers usable by the
280 * RETURNS: total number of scratch pad registers available
282 uint8_t ntb_spad_count(device_t ntb);
285 * ntb_get_max_spads() - zero local scratch registers
286 * @ntb: pointer to ntb_softc instance
288 * This functions overwrites all local scratchpad registers with zeroes.
290 void ntb_spad_clear(device_t ntb);
293 * ntb_spad_write() - write to the secondary scratchpad register
294 * @ntb: pointer to ntb_softc instance
295 * @idx: index to the scratchpad register, 0 based
296 * @val: the data value to put into the register
298 * This function allows writing of a 32bit value to the indexed scratchpad
299 * register. The register resides on the secondary (external) side.
301 * RETURNS: An appropriate ERRNO error value on error, or zero for success.
303 int ntb_spad_write(device_t ntb, unsigned int idx, uint32_t val);
306 * ntb_spad_read() - read from the primary scratchpad register
307 * @ntb: pointer to ntb_softc instance
308 * @idx: index to scratchpad register, 0 based
309 * @val: pointer to 32bit integer for storing the register value
311 * This function allows reading of the 32bit scratchpad register on
312 * the primary (internal) side.
314 * RETURNS: An appropriate ERRNO error value on error, or zero for success.
316 int ntb_spad_read(device_t ntb, unsigned int idx, uint32_t *val);
319 * ntb_peer_spad_write() - write to the secondary scratchpad register
320 * @ntb: pointer to ntb_softc instance
321 * @idx: index to the scratchpad register, 0 based
322 * @val: the data value to put into the register
324 * This function allows writing of a 32bit value to the indexed scratchpad
325 * register. The register resides on the secondary (external) side.
327 * RETURNS: An appropriate ERRNO error value on error, or zero for success.
329 int ntb_peer_spad_write(device_t ntb, unsigned int idx, uint32_t val);
332 * ntb_peer_spad_read() - read from the primary scratchpad register
333 * @ntb: pointer to ntb_softc instance
334 * @idx: index to scratchpad register, 0 based
335 * @val: pointer to 32bit integer for storing the register value
337 * This function allows reading of the 32bit scratchpad register on
338 * the primary (internal) side.
340 * RETURNS: An appropriate ERRNO error value on error, or zero for success.
342 int ntb_peer_spad_read(device_t ntb, unsigned int idx, uint32_t *val);
345 * ntb_db_valid_mask() - get a mask of doorbell bits supported by the ntb
346 * @ntb: NTB device context
348 * Hardware may support different number or arrangement of doorbell bits.
350 * Return: A mask of doorbell bits supported by the ntb.
352 uint64_t ntb_db_valid_mask(device_t ntb);
355 * ntb_db_vector_count() - get the number of doorbell interrupt vectors
356 * @ntb: NTB device context.
358 * Hardware may support different number of interrupt vectors.
360 * Return: The number of doorbell interrupt vectors.
362 int ntb_db_vector_count(device_t ntb);
365 * ntb_db_vector_mask() - get a mask of doorbell bits serviced by a vector
366 * @ntb: NTB device context
367 * @vector: Doorbell vector number
369 * Each interrupt vector may have a different number or arrangement of bits.
371 * Return: A mask of doorbell bits serviced by a vector.
373 uint64_t ntb_db_vector_mask(device_t ntb, uint32_t vector);
376 * ntb_peer_db_addr() - address and size of the peer doorbell register
377 * @ntb: NTB device context.
378 * @db_addr: OUT - The address of the peer doorbell register.
379 * @db_size: OUT - The number of bytes to write the peer doorbell register.
381 * Return the address of the peer doorbell register. This may be used, for
382 * example, by drivers that offload memory copy operations to a dma engine.
383 * The drivers may wish to ring the peer doorbell at the completion of memory
384 * copy operations. For efficiency, and to simplify ordering of operations
385 * between the dma memory copies and the ringing doorbell, the driver may
386 * append one additional dma memory copy with the doorbell register as the
387 * destination, after the memory copy operations.
389 * Return: Zero on success, otherwise an error number.
391 * Note that writing the peer doorbell via a memory window will *not* generate
392 * an interrupt on the remote host; that must be done separately.
394 int ntb_peer_db_addr(device_t ntb, bus_addr_t *db_addr, vm_size_t *db_size);
397 * ntb_db_clear() - clear bits in the local doorbell register
398 * @ntb: NTB device context.
399 * @db_bits: Doorbell bits to clear.
401 * Clear bits in the local doorbell register, arming the bits for the next
404 * Return: Zero on success, otherwise an error number.
406 void ntb_db_clear(device_t ntb, uint64_t bits);
409 * ntb_db_clear_mask() - clear bits in the local doorbell mask
410 * @ntb: NTB device context.
411 * @db_bits: Doorbell bits to clear.
413 * Clear bits in the local doorbell mask register, allowing doorbell interrupts
414 * from being generated for those doorbell bits. If a doorbell bit is already
415 * set at the time the mask is cleared, and the corresponding mask bit is
416 * changed from set to clear, then the ntb driver must ensure that
417 * ntb_db_event() is called. If the hardware does not generate the interrupt
418 * on clearing the mask bit, then the driver must call ntb_db_event() anyway.
420 * Return: Zero on success, otherwise an error number.
422 void ntb_db_clear_mask(device_t ntb, uint64_t bits);
425 * ntb_db_read() - read the local doorbell register
426 * @ntb: NTB device context.
428 * Read the local doorbell register, and return the bits that are set.
430 * Return: The bits currently set in the local doorbell register.
432 uint64_t ntb_db_read(device_t ntb);
435 * ntb_db_set_mask() - set bits in the local doorbell mask
436 * @ntb: NTB device context.
437 * @db_bits: Doorbell mask bits to set.
439 * Set bits in the local doorbell mask register, preventing doorbell interrupts
440 * from being generated for those doorbell bits. Bits that were already set
443 * Return: Zero on success, otherwise an error number.
445 void ntb_db_set_mask(device_t ntb, uint64_t bits);
448 * ntb_peer_db_set() - Set the doorbell on the secondary/external side
449 * @ntb: pointer to ntb_softc instance
450 * @bit: doorbell bits to ring
452 * This function allows triggering of a doorbell on the secondary/external
453 * side that will initiate an interrupt on the remote host
455 void ntb_peer_db_set(device_t ntb, uint64_t bits);