Lines Matching +full:a +full:- +full:c
5 -------------------
9 achieved via a call to :c:func:`vme_register_driver`.
11 A pointer to a structure of type :c:type:`struct vme_driver <vme_driver>` must
16 :c:type:`struct vme_driver <vme_driver>` should be correctly set. The '.name'
17 element is a pointer to a string holding the device driver's name.
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)
35 The '.probe' element should contain a pointer to the probe routine. The
36 probe routine is passed a :c:type:`struct vme_dev <vme_dev>` pointer as an
41 dev->bridge->num.
43 A function is also provided to unregister the driver from the VME core called
44 :c:func:`vme_unregister_driver` and should usually be called from the device
49 -------------------
51 Once a driver has registered with the VME core the provided match routine will
52 be called the number of times specified during the registration. If a match
53 succeeds, a non-zero value should be returned. A zero return value indicates
55 driver is called. The probe routine is passed a pointer to the devices
60 (:c:func:`vme_master_request`), slave windows (:c:func:`vme_slave_request`)
61 and/or dma channels (:c:func:`vme_dma_request`). Rather than allowing the device
62 driver to request a specific window or DMA channel (which may be used by a
63 different driver) the API allows a resource to be assigned based on the required
66 bus cycle types required in 'cycle'. Master windows add a further set of
69 attributes can be requested for a single window, the core will assign a window
70 that meets the requirements, returning a pointer of type vme_resource that
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
76 the requirements can not be found a NULL pointer will be returned.
79 required. These functions (:c:func:`vme_master_free`, :c:func:`vme_slave_free`
80 and :c:func:`vme_dma_free`) should be passed the pointer to the resource
85 --------------
89 the underlying chipset. A window must be configured before it can be used.
95 Once a master window has been assigned :c:func:`vme_master_set` can be used to
96 configure it and :c:func:`vme_master_get` to retrieve the current settings. The
105 The function :c:func:`vme_master_read` can be used to read from and
106 :c:func:`vme_master_write` used to write to configured master windows.
108 In addition to simple reads and writes, :c:func:`vme_master_rmw` is provided to
109 do a read-modify-write transaction. Parts of a VME window can also be mapped
110 into user space memory using :c:func:`vme_master_mmap`.
114 -------------
118 used is dependent on the underlying chipset. A window must be configured before
125 Once a slave window has been assigned :c:func:`vme_slave_set` can be used to
126 configure it and :c:func:`vme_slave_get` to retrieve the current settings.
137 (:c:func:`vme_alloc_consistent`) and free (:c:func:`vme_free_consistent`)
139 do not have to be used, other methods can be used to allocate a buffer, though
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
156 be passed to a DMA controller. Multiple lists can be created, extended,
163 The function :c:func:`vme_new_dma_list` is provided to create and
164 :c:func:`vme_dma_list_free` to destroy DMA lists. Execution of a list will not
165 automatically destroy the list, thus enabling a list to be reused for repetitive
172 An item can be added to a list using :c:func:`vme_dma_list_add` (the source and
179 are not checked until an entry is added to a DMA list, the request
180 for a DMA channel purely checks the directions in which the
181 controller is expected to transfer data. As a result it is
189 an item to a list. This is due to the diverse attributes required for each type
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
220 :c:func:`vme_irq_free` to free a specific VME level and status ID combination.
221 Any given combination can only be assigned a single callback function. A void
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
236 at a given VME level and VME status ID.
240 -----------------
249 The function :c:func:`vme_lm_request` is provided to request the use of a block
250 of location monitors and :c:func:`vme_lm_free` to free them after they are no
251 longer required. Each block may provide a number of location monitors,
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
260 :c:func:`vme_lm_set` is provided to configure the location and mode of the
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
269 :c:func:`vme_lm_detach` allows on to be detached from each location monitor
270 location. Each location monitor can monitor a number of adjacent locations. The
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