This is the cl-libiio Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:24:39 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-libiioCommon Lisp bindings for libiio (https://github.com/analogdevicesinc/libiio).
Mihai Olteanu
GPLv3
0.1
cffi (system).
package.lisp (file).
cl-libiio.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-libiio/cl-libiio.lisppackage.lisp (file).
cl-libiio (system).
iio-backends (function).
iio-buffer-cancel (function).
iio-buffer-collect-all-samples (function).
iio-buffer-collect-channel-samples (function).
iio-buffer-destroy (function).
iio-buffer-end (function).
iio-buffer-first (function).
iio-buffer-foreach-sample (function).
iio-buffer-get-device (function).
iio-buffer-get-poll-fd (function).
iio-buffer-push (function).
iio-buffer-push-partial (function).
iio-buffer-refill (function).
iio-buffer-samples-count (function).
iio-buffer-set-blocking-mode (function).
iio-buffer-start (function).
iio-buffer-step (function).
iio-channel-attr-get-filename (function).
iio-channel-attr-read (function).
iio-channel-attr-read-all (function).
iio-channel-attr-write (function).
iio-channel-attrs (function).
iio-channel-disable (function).
iio-channel-enable (function).
iio-channel-find-attr (function).
iio-channel-get-attr (function).
iio-channel-get-attrs-count (function).
iio-channel-get-data-format (function).
iio-channel-get-device (function).
iio-channel-get-id (function).
iio-channel-get-index (function).
iio-channel-get-modifier (function).
iio-channel-get-name (function).
iio-channel-get-type (function).
iio-channel-is-enabled (function).
iio-channel-is-output (function).
iio-channel-is-scan-element (function).
iio-channel-read (function).
iio-channel-write (function).
iio-context-clone (function).
iio-context-destroy (function).
iio-context-find-device (function).
iio-context-get-attr (function).
iio-context-get-attr-value (function).
iio-context-get-attrs (function).
iio-context-get-attrs-and-values (function).
iio-context-get-attrs-count (function).
iio-context-get-description (function).
iio-context-get-device (function).
iio-context-get-devices-count (function).
iio-context-get-name (function).
iio-context-get-version (function).
iio-context-get-xml (function).
iio-context-set-timeout (function).
iio-create-context-from-uri (function).
iio-create-default-context (function).
iio-create-local-context (function).
iio-create-network-context (function).
iio-create-scan-context (function).
iio-create-xml-context (function).
iio-create-xml-context-mem (function).
iio-device-attr-read (function).
iio-device-attr-read-all (function).
iio-device-attr-write (function).
iio-device-attrs (function).
iio-device-buffer-attr-read (function).
iio-device-buffer-attr-read-all (function).
iio-device-buffer-attr-write (function).
iio-device-buffer-attrs (function).
iio-device-create-buffer (function).
iio-device-enabled-channels (function).
iio-device-enabled-channels-count (function).
iio-device-find-attr (function).
iio-device-find-buffer-attr (function).
iio-device-find-channel (function).
iio-device-get-attr (function).
iio-device-get-attrs-count (function).
iio-device-get-buffer-attr (function).
iio-device-get-buffer-attrs-count (function).
iio-device-get-channel (function).
iio-device-get-channels (function).
iio-device-get-channels-count (function).
iio-device-get-channels-str (function).
iio-device-get-context (function).
iio-device-get-id (function).
iio-device-get-name (function).
iio-device-get-sample-size (function).
iio-device-get-trigger (function).
iio-device-is-trigger (function).
iio-device-set-kernel-buffers-count (function).
iio-device-set-trigger (function).
iio-get-backend (function).
iio-get-backends-count (function).
iio-has-backend (function).
iio-library-get-version (function).
iio-scan-context-destroy (function).
iio-scan-context-get-info-list (function).
iio-strerror (function).
iio-success-p (function).
%var-accessor-*errno* (function).
(setf %var-accessor-*errno*) (function).
*errno* (symbol macro).
channel-info (function).
context-info (function).
device-info (function).
foreign-funcall-with-err-handle (macro).
iio-context-get-devices-pointers (function).
iio-context-get-devices-str (function).
iio-data-format-tclass (class).
iio-data-format-to-plist (function).
Packages are listed by definition order.
cl-libiiocffi.
common-lisp.
iio-backends (function).
iio-buffer-cancel (function).
iio-buffer-collect-all-samples (function).
iio-buffer-collect-channel-samples (function).
iio-buffer-destroy (function).
iio-buffer-end (function).
iio-buffer-first (function).
iio-buffer-foreach-sample (function).
iio-buffer-get-device (function).
iio-buffer-get-poll-fd (function).
iio-buffer-push (function).
iio-buffer-push-partial (function).
iio-buffer-refill (function).
iio-buffer-samples-count (function).
iio-buffer-set-blocking-mode (function).
iio-buffer-start (function).
iio-buffer-step (function).
iio-channel-attr-get-filename (function).
iio-channel-attr-read (function).
iio-channel-attr-read-all (function).
iio-channel-attr-write (function).
iio-channel-attrs (function).
iio-channel-disable (function).
iio-channel-enable (function).
iio-channel-find-attr (function).
iio-channel-get-attr (function).
iio-channel-get-attrs-count (function).
iio-channel-get-data-format (function).
iio-channel-get-device (function).
iio-channel-get-id (function).
iio-channel-get-index (function).
iio-channel-get-modifier (function).
iio-channel-get-name (function).
iio-channel-get-type (function).
iio-channel-is-enabled (function).
iio-channel-is-output (function).
iio-channel-is-scan-element (function).
iio-channel-read (function).
iio-channel-write (function).
iio-context-clone (function).
iio-context-destroy (function).
iio-context-find-device (function).
iio-context-get-attr (function).
iio-context-get-attr-value (function).
iio-context-get-attrs (function).
iio-context-get-attrs-and-values (function).
iio-context-get-attrs-count (function).
iio-context-get-description (function).
iio-context-get-device (function).
iio-context-get-devices-count (function).
iio-context-get-name (function).
iio-context-get-version (function).
iio-context-get-xml (function).
iio-context-set-timeout (function).
iio-create-context-from-uri (function).
iio-create-default-context (function).
iio-create-local-context (function).
iio-create-network-context (function).
iio-create-scan-context (function).
iio-create-xml-context (function).
iio-create-xml-context-mem (function).
iio-device-attr-read (function).
iio-device-attr-read-all (function).
iio-device-attr-write (function).
iio-device-attrs (function).
iio-device-buffer-attr-read (function).
iio-device-buffer-attr-read-all (function).
iio-device-buffer-attr-write (function).
iio-device-buffer-attrs (function).
iio-device-create-buffer (function).
iio-device-enabled-channels (function).
iio-device-enabled-channels-count (function).
iio-device-find-attr (function).
iio-device-find-buffer-attr (function).
iio-device-find-channel (function).
iio-device-get-attr (function).
iio-device-get-attrs-count (function).
iio-device-get-buffer-attr (function).
iio-device-get-buffer-attrs-count (function).
iio-device-get-channel (function).
iio-device-get-channels (function).
iio-device-get-channels-count (function).
iio-device-get-channels-str (function).
iio-device-get-context (function).
iio-device-get-id (function).
iio-device-get-name (function).
iio-device-get-sample-size (function).
iio-device-get-trigger (function).
iio-device-is-trigger (function).
iio-device-set-kernel-buffers-count (function).
iio-device-set-trigger (function).
iio-get-backend (function).
iio-get-backends-count (function).
iio-has-backend (function).
iio-library-get-version (function).
iio-scan-context-destroy (function).
iio-scan-context-get-info-list (function).
iio-strerror (function).
iio-success-p (function).
%var-accessor-*errno* (function).
(setf %var-accessor-*errno*) (function).
*errno* (symbol macro).
channel-info (function).
context-info (function).
device-info (function).
foreign-funcall-with-err-handle (macro).
iio-context-get-devices-pointers (function).
iio-context-get-devices-str (function).
iio-data-format-tclass (class).
iio-data-format-to-plist (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Get all the avaliable backends, as strings.
Return the buffer values for all the enabled channels. [EXTRA] The return values are lists where the first element is the channel id and the second element is the samples read from the buffer.
Return the buffer values for a single channel.
Destroy the given buffer.
Get the address that follows the last sample in a buffer.
Find the first sample of a channel in a buffer.
[Not implemented] Call the supplied callback for each sample found in a buffer.
Retrieve a pointer to the iio_device structure.
Send the samples to the hardware.
Send a given number of samples to the hardware.
Fetch more samples from the hardware.
Return the number of samples currently in the buffer. [EXTRA]
Get the start address of the buffer
Get the step size between two samples of one channel.
Retrieve the filename of an attribute.
Read the content of the given channel-specific attribute.
Read the content of all channel-specific attributes. libiio function available, but we don’t use that.
Set the value of the given channel-specific attribute.
Return all channel attributes as strings. [EXTRA]
Disable the given channel.
Enable the given channel.
Try to find a channel-specific attribute by its name.
Get the channel-specific attribute present at the given index.
Enumerate the channel-specific attributes of the given channel.
Get a pointer to a channel’s data format structure
Retrieve a pointer to the iio_device structure.
Retrieve the channel ID.
Get the index of the given channel
Get the modifier type of the given channel.
Retrieve the channel name.
Get the type of the given channel.
Return t if the channel is enabled.
Return t if the given channel is an output channel.
Return t if the given channel is a scan element.
[Not implemented] Demultiplex and convert the samples of a given channel.
[Not implemented] Convert and multiplex the samples of a given channel.
Duplicate a pre-existing IIO context.
Destroy the given context.
Try to find a device structure by its name of ID.
Retrieve the name and value of a context-specific attribute.
Retrieve the value of a context-specific attribute.
Return all the context’s attributes, as strings [EXTRA].
Return all the context’s attributes and values [EXTRA].
Get the number of context-specific attributes.
Get a description of the given context.
Get the device present at the given index.
Enumerate the devices found in the given context.
Get the name of the given context.
Get the version of the backend in use.
Obtain a XML representation of the given context.
Set a timeout for I/O operations.
Create a context from a URI description.
Create a context from local or remote IIO devices.
Create a context from local IIO devices (Linux only).
Create a context from the network
Create a context besed on the backend (ip, usb or xml). Use empty string for backend to search all of them.
Create a context from a XML file
Create a context from XML data in memory
Read the content of the given device-specific attribute.
Read the content of all device-specific attributes. libiio function available, but we don’t use that.
Set the value of the given device-specific attribute.
Read all device attributes. [EXTRA]
Read the content of all buffer-specific attributes. libiio function available, but we don’t use that.
Return the device attributes as strings. [EXTRA]
Create an input or output buffer associated to the given device.
Returns a list of enabled channels, as pointers. [EXTRA]
Return the number of enabled channels for the device. [EXTRA]
Try to find a device-specific attribute by its name
Try to find a buffer-specific attribute by its name.
Try to find a channel structure by its name of ID.
Get the device-specific attribute present at the given index.
Enumerate the device-specific attributes of the given device
Enumerate the buffer-specific attributes of the given device.
Get the channel present at the given index.
Return all channels for the given device, as pointers to channels [EXTRA].
Enumerate the channels of the given device.
Return all channels for the given device, as strings [EXTRA].
Retrieve a pointer to the iio_context structure.
Retrieve the device ID.
Retrieve the device name.
Get the current sample size.
On success, the sample size in bytes is returned.
Warning! The sample size is not constant and will change when channels
get enabled or disabled, for example: If one channel is enabled and
the returned sample size is two (bytes); and if then another channel
is enabled and the returned sample size is four (bytes), and you
create a buffer with 10 samples count, then the buffer will be filled
with 40 bytes, where the first two bytes are the first channel sample,
the next two bytes are the second channel sample, and so on.
Retrieve the trigger of a given device.
Return t if the given device is a trigger.
Configure the number of kernel buffers for a device.
Get the number of available backends
Check if the specified backend is available.
Get the version of the libiio library.
Destroy the given scan context.
Enumerate available contexts.
Get a string description of the error code.
Return t if return-value is non-negative [EXTRA].
Useful for libiio functions which signal an error by returning a
negative error code.
Same as foreign-funcall, but there is an extra form at the end to be evaluated. Its value is returned if the foreign call is succesful. Otherwise, return nil, together with the error code and the error string. Inside the last form, the calling function can reference ‘return-value’ which is bound to the result of calling the foreign function.
Return a list with the channel name and all of its attributes together with their values. In a word, return all the info available for the given channel. [EXTRA]
Return a list with all the context devices, channels, attributes. In a word, return all the info available for the given context. [EXTRA]
Return a list with the device attributes and all the channels and their attributes. In a word, return all the info available for the given device. [EXTRA]
Return all devices for the given context, as pointers [EXTRA].
Return all devices for the given context, as strings [EXTRA].
foreign-struct-type.
translatable-foreign-type.
| Jump to: | %
(
C D F I M |
|---|
| Jump to: | %
(
C D F I M |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*errno*: | Private symbol macros | ||
| | |||
| S | |||
Symbol Macro, *errno*: | Private symbol macros | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | C F I P S |
|---|
| Jump to: | C F I P S |
|---|