Documentation/driver-api/vme.rst

5 -------------------
12 be provided to the registration function. Along with the maximum number of
19 The '.match' function allows control over which VME devices should be registered
20 with the driver. The match function should return 1 if a device should be
21 probed and 0 otherwise. This example match function (from vme_user.c) limits
24 .. code-block:: c
30 		if (vdev->id.num >= USER_BUS_MAX)
41 dev->bridge->num.
43 A function is also provided to unregister the driver from the VME core called
49 -------------------
53 succeeds, a non-zero value should be returned. A zero return value indicates
67 attributes in 'width' specifying the required data transfer widths. These
72 controllers, the request function requires the potential direction of any
73 transfers to be provided in the route attributes. This is typically VME-to-MEM
74 and/or MEM-to-VME, though some hardware can support VME-to-VME and MEM-to-MEM
85 --------------
97 address spaces, transfer widths and cycle types are the same as described
105 The function :c:func:`vme_master_read` can be used to read from and
109 do a read-modify-write transaction. Parts of a VME window can also be mapped
114 -------------
128 The address spaces, transfer widths and cycle types are the same as described
152 ------------
154 The VME DMA transfer provides the ability to run link-list DMA transfers. The
155 API introduces the concept of DMA lists. Each DMA list is a link-list which can
163 The function :c:func:`vme_new_dma_list` is provided to create and
173 destination attributes need to be created before calling this function, this is
174 covered under "Transfer Attributes").
181 	controller is expected to transfer data. As a result it is
185 Transfer Attributes
193  - PCI source or destination: :c:func:`vme_dma_pci_attribute`
194  - VME source or destination: :c:func:`vme_dma_vme_attribute`
195  - Pattern source: :c:func:`vme_dma_pattern_attribute`
197 The function :c:func:`vme_dma_free_attribute` should be used to free an
204 The function :c:func:`vme_dma_list_exec` queues a list for execution and will
209 ----------
219 The function :c:func:`vme_irq_request` can be used to attach and
221 Any given combination can only be assigned a single callback function. A void
223 function, the use of this pointer is user undefined. The callback parameters are
224 as follows. Care must be taken in writing a callback function, callback
227 .. code-block:: c
235 The function :c:func:`vme_irq_generate` can be used to generate a VME interrupt
240 -----------------
249 The function :c:func:`vme_lm_request` is provided to request the use of a block
252 monitoring adjacent locations. The function :c:func:`vme_lm_count` can be used
259 Once a bank of location monitors has been allocated, the function
261 location monitor. The function :c:func:`vme_lm_get` can be used to retrieve
268 The function :c:func:`vme_lm_attach` enables a callback to be attached and
271 callback function is declared as follows.
273 .. code-block:: c
279 --------------
281 The function :c:func:`vme_slot_num` returns the slot ID of the provided bridge.
285 -------------
287 The function :c:func:`vme_bus_num` returns the bus ID of the provided bridge.
291 -------
293 .. kernel-doc:: drivers/staging/vme_user/vme.h
296 .. kernel-doc:: drivers/staging/vme_user/vme.c