|
EDT PCD SDK Documentation 6.2.1
|
Functions | |
| int | edt_close (EdtDev edt_p) |
| Shut down all pending I/O operations, closes the device or channel and frees all resources associated with the device handle. More... | |
| EDT_CHECK_RETURN EdtDev | edt_open (const char *device_name, int unit) |
Open the specified EDT board and sets up the device handle. Equivalent to edt_open_device(device_name, unit, channel: 0, verbose: 1). More... | |
| EDT_CHECK_RETURN EdtDev | edt_open_quiet (const char *device_name, int unit) |
Same as edt_open(), but with fewer log messages. Equivalent to edt_open_device(device_name, unit, channel: 0, verbose: 0). More... | |
| EDT_CHECK_RETURN EdtDev | edt_open_channel (const char *device_name, int unit, int channel) |
Open a specific DMA channel on the specified EDT board. Equivalent to edt_open_device(device_name, unit, channel, verbose: 1). More... | |
| EDT_CHECK_RETURN EdtDev | edt_open_device (const char *device_name, int unit, int channel, int verbose) |
| Open a specific EDT board and DMA channel. More... | |
| void | edt_set_port (EdtDev edt_p, EdtIOPort port) |
Set the port number, as distinct from the DMA channel. More... | |
| EdtIOPort | edt_get_port (EdtDev edt_p) |
| Get the port number set by edt_set_port(). More... | |
These functions are used to open and close the EDT device.
| int edt_close | ( | EdtDev | edt_p | ) |
Shut down all pending I/O operations, closes the device or channel and frees all resources associated with the device handle.
| edt_p | The open EDT device handle. |
| EDT_CHECK_RETURN EdtDev edt_open | ( | const char * | device_name, |
| int | unit | ||
| ) |
Open the specified EDT board and sets up the device handle. Equivalent to edt_open_device(device_name, unit, channel: 0, verbose: 1).
| device_name | Pass EDT_INTERFACE. Open a dummy device for testing by passing "dmy". |
| unit | Unit number of the device. Unit numbers start at 0. |
Once opened, the device handle may be used to perform I/O using edt_read(), edt_write(), edt_configure_ring_buffers(), and other input-output library calls. When finished, use edt_close() to release allocated resources.
| EDT_CHECK_RETURN EdtDev edt_open_quiet | ( | const char * | device_name, |
| int | unit | ||
| ) |
Same as edt_open(), but with fewer log messages. Equivalent to edt_open_device(device_name, unit, channel: 0, verbose: 0).
| device_name | Pass EDT_INTERFACE. Open a dummy device for testing by passing "dmy". |
| unit | Unit number of the device. Unit numbers start at 0. |
Once opened, the device handle may be used to perform I/O using edt_read(), edt_write(), edt_configure_ring_buffers(), and other input-output library calls. When finished, use edt_close() to release allocated resources.
| EDT_CHECK_RETURN EdtDev edt_open_channel | ( | const char * | device_name, |
| int | unit, | ||
| int | channel | ||
| ) |
Open a specific DMA channel on the specified EDT board. Equivalent to edt_open_device(device_name, unit, channel, verbose: 1).
| device_name | Pass EDT_INTERFACE. Open a dummy device for testing by passing "dmy". |
| unit | Unit number of the device. Unit numbers start at 0. |
| channel | DMA channel number, starting from 0. |
Once opened, the device handle may be used to perform I/O using edt_read(), edt_write(), edt_configure_ring_buffers(), and other input-output library calls. When finished, use edt_close() to release allocated resources.
| EDT_CHECK_RETURN EdtDev edt_open_device | ( | const char * | device_name, |
| int | unit, | ||
| int | channel, | ||
| int | verbose | ||
| ) |
Open a specific EDT board and DMA channel.
| device_name | Pass EDT_INTERFACE. Open a dummy device for testing by passing "dmy". |
| unit | Unit number of the device. Unit numbers start at 0. |
| channel | DMA channel number, starting from 0. |
| verbose | Enable (true / non-zero) messages on successful open, or error messages on failure. Pass false or 0 to disable. |
Once opened, the device handle may be used to perform I/O using edt_read(), edt_write(), edt_configure_ring_buffers(), and other input-output library calls. When finished, use edt_close() to release allocated resources.
Set the port number, as distinct from the DMA channel.
| edt_p | The open EDT device handle. |
| port | Port number enum. |
Get the port number set by edt_set_port().
| edt_p | The open EDT device handle. |
Routine to get the "port" number, as distinct from the dma channel