The cl-spidev Reference Manual

This is the cl-spidev Reference Manual, version 1.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:44:06 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-spidev

A library for the Linux SPIDEV kernel module as used on hobby kits such as the Raspberry Pi

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://Shinmera.github.io/cl-spidev/

Source Control

(GIT https://github.com/Shinmera/cl-spidev.git)

Bug Tracker

https://github.com/Shinmera/cl-spidev/issues

License

zlib

Version

1.1.0

Dependencies
  • documentation-utils (system).
  • trivial-garbage (system).
  • cffi (system).
Source

cl-spidev.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-spidev/cl-spidev.asd

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).

ASDF Systems

cl-spidev.


3.1.2 cl-spidev/package.lisp

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).

Packages

3.1.3 cl-spidev/ioctl.lisp

Dependency

package.lisp (file).

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).

Internals

3.1.4 cl-spidev/constants.lisp

Dependency

ioctl.lisp (file).

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).

Public Interface
Internals

3.1.5 cl-spidev/low-level.lisp

Dependency

constants.lisp (file).

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).

Public Interface
Internals

3.1.6 cl-spidev/wrapper.lisp

Dependency

low-level.lisp (file).

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).

Public Interface
Internals

3.1.7 cl-spidev/documentation.lisp

Dependency

wrapper.lisp (file).

Source

cl-spidev.asd.

Parent Component

cl-spidev (system).


4 Packages

Packages are listed by definition order.


4.1 cl-spidev

Source

package.lisp.

Nicknames
  • org.shirakumo.spidev
  • spidev
Use List

common-lisp.

Public Interface
Internals

4.2 cl-spidev-lli

Source

package.lisp.

Nickname

org.shirakumo.spidev.lli

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Constants

Constant: spi-3wire

Constant holding the value defined in the kernel constant SPI_3WIRE.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-cpol

Constant holding the value defined in the kernel constant SPI_CPOL.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-cs-high

Constant holding the value defined in the kernel constant SPI_CS_HIGH.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-message-1

Constant holding the value defined in the kernel constant SPI_IOC_MESSAGE(1).

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-rd-bits-per-word

Constant holding the value defined in the kernel constant SPI_IOC_RD_BITS_PER_WORD.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-rd-lsb-first

Constant holding the value defined in the kernel constant SPI_IOC_RD_LSB_FIRST.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-rd-max-speed-hz

Constant holding the value defined in the kernel constant SPI_IOC_RD_MAX_SPEED_HZ.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-rd-mode

Constant holding the value defined in the kernel constant SPI_IOC_RD_MODE.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-rd-mode32

Constant holding the value defined in the kernel constant SPI_IOC_RD_MODE32.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-wr-bits-per-word

Constant holding the value defined in the kernel constant SPI_IOC_WR_BITS_PER_WORD.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-wr-lsb-first

Constant holding the value defined in the kernel constant SPI_IOC_WR_LSB_FIRST.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-wr-max-speed-hz

Constant holding the value defined in the kernel constant SPI_IOC_WR_MAX_SPEED_HZ.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-wr-mode

Constant holding the value defined in the kernel constant SPI_IOC_WR_MODE.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ioc-wr-mode32

Constant holding the value defined in the kernel constant SPI_IOC_WR_MODE32.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-loop

Constant holding the value defined in the kernel constant SPI_LOOP.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-lsb-first

Constant holding the value defined in the kernel constant SPI_LSB_FIRST.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-mode-0

Constant holding the value defined in the kernel constant SPI_MODE_0.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-mode-1

Constant holding the value defined in the kernel constant SPI_MODE_1.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-mode-2

Constant holding the value defined in the kernel constant SPI_MODE_2.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-mode-3

Constant holding the value defined in the kernel constant SPI_MODE_3.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-no-cs

Constant holding the value defined in the kernel constant SPI_NO_CS.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-ready

Constant holding the value defined in the kernel constant SPI_READY.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-rx-dual

Constant holding the value defined in the kernel constant SPI_RX_DUAL.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-rx-quad

Constant holding the value defined in the kernel constant SPI_RX_QUAD.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-tx-dual

Constant holding the value defined in the kernel constant SPI_TX_DUAL.

Package

cl-spidev-lli.

Source

constants.lisp.

Constant: spi-tx-quad

Constant holding the value defined in the kernel constant SPI_TX_QUAD.

Package

cl-spidev-lli.

Source

constants.lisp.


5.1.2 Special variables

Special Variable: *spidev-root*

The root path for SPIDEV devices. Should be /dev/

Package

cl-spidev-lli.

Source

low-level.lisp.


5.1.3 Macros

Macro: with-open-spi ((handle id &key direction) &body body)

Convenience wrapper to lexically retain a handle to a SPIDEV device.

See OPEN-SPI
See CLOSE-SPI

Package

cl-spidev-lli.

Source

low-level.lisp.


5.1.4 Ordinary functions

Reader: bits/word (instance)

Accessor to how many bits there are in a word on the device.

Should be an (UNSIGNED-BYTE 8) value.

See HANDLE

Package

cl-spidev.

Alias for

handle-bits/word.

Function: (setf bits/word) (handle)
Package

cl-spidev.

Source

wrapper.lisp.

Function: bits/word (handle)

Accessor to how many bits there are per word on the SPIDEV device.

The value should be a positive integer, where 0 defaults to 8.

See IOCTL
See SPI-IOC-RD-BITS-PER-WORD
See SPI-IOC-WR-BITS-PER-WORD

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: (setf bits/word) (handle)
Package

cl-spidev-lli.

Source

low-level.lisp.

Function: close (handle)

Safely closes the SPIDEV device. It becomes unusable after this.

See HANDLE

Package

cl-spidev.

Source

wrapper.lisp.

Function: close-spi (handle)

Close a handle to a SPIDEV device.

See WITH-OPEN-SPI

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: devices ()

Return a list of available SPIDEV devices on the system.

Package

cl-spidev-lli.

Source

low-level.lisp.

Reader: handle (instance)

Returns the underlying stream handle of the handle object.

This is useful when you need to interact with the low-level system directly for some reason.

See HANDLE

Package

cl-spidev.

Alias for

handle-stream.

Reader: lsb-first (instance)

Accessor to whether the least significant byte comes first.

Should be a boolean.

See HANDLE

Package

cl-spidev.

Alias for

handle-lsb-first.

Function: (setf lsb-first) (handle)
Package

cl-spidev.

Source

wrapper.lisp.

Function: lsb-first (handle)

Accessor to whether the least significant byte comes first on the SPIDEV device.

The value should be T or NIL.

See IOCTL
See SPI-IOC-RD-LSB-FIRST
See SPI-IOC-WR-LSB-FIRST

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: (setf lsb-first) (handle)
Package

cl-spidev-lli.

Source

low-level.lisp.

Reader: max-speed (instance)

Accessor to the maximum transfer speed of the SPIDEV device in Hertz.

Should be an (UNSIGNED-BYTE 32) value.
The device may reject your requested speed, in which case a warning is signalled and the actual speed is returned.

See HANDLE

Package

cl-spidev.

Alias for

handle-max-speed.

Function: (setf max-speed) (handle)
Package

cl-spidev.

Source

wrapper.lisp.

Function: max-speed (handle)

Accessor to the maximum speed frequency of the SPIDEV device in Hertz.

The value should be a positive integer. If it is too large and
the device refuses to adjust to it, a warning is signalled.

The actual rate in Hertz is returned.

See IOCTL
See SPI-IOC-RD-MAX-SPEED-HZ
See SPI-IOC-WR-MAX-SPEED-HZ

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: (setf max-speed) (handle)
Package

cl-spidev-lli.

Source

low-level.lisp.

Reader: mode (instance)

Accessor to the SPIDEV device’s transfer mode.

The value should be one of :MODE-0 :MODE-1 :MODE-2 :MODE-3

See HANDLE

Package

cl-spidev.

Alias for

handle-mode.

Function: (setf mode) (handle)
Package

cl-spidev.

Source

wrapper.lisp.

Function: mode (handle)

Accessor to the mode in which the SPIDEV device operates.

The value should be one of :MODE-0 :MODE-1 :MODE-2 :MODE-3 or a specific mode integer.

See IOCTL
See SPI-IOC-WR-MODE32
See SPI-IOC-RD-MODE32
See SPI-MODE-0
See SPI-MODE-1
See SPI-MODE-2
See SPI-MODE-3

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: (setf mode) (handle)
Package

cl-spidev-lli.

Source

low-level.lisp.

Function: open (id)

Open a handle to a SPIDEV device.

This will produce a safe object that will always ensure the underlying file-system handle is closed when the object is no longer referenced. It will also cache the properties of the underlying device, so read access to them should be fast.

See HANDLE

Package

cl-spidev.

Source

wrapper.lisp.

Function: open-spi (id &key direction)

Open a handle to a SPIDEV device.

See WITH-OPEN-SPI

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: read (bytes handle &key start end)

Read a sequence of words from the SPIDEV device.

The bytes vector should be able to contain unsigned-bytes of size up to the number of BITS/WORD of the handle.

See HANDLE
See READ*

Package

cl-spidev.

Source

wrapper.lisp.

Function: read* (n handle)

Read n words from the SPIDEV device into a fresh array.

See READ

Package

cl-spidev.

Source

wrapper.lisp.

Function: read-bytes (bytes handle &key start end)

Reads a byte sequence from the SPIDEV device handle.

See LSB-FIRST
See BITS/WORD

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: transmit (handle bytes &key speed delay bits/word)

Perform a SPI transmission of the given byte sequence.

The array must be an unsigned-byte 8 array.

The speed-hz, delay-usecs, and bits/word parameters are temp overrides for the device configuration during the transmission. They default to MAX-SPEED, 0, and BITS/WORD respectively.

Returned is a fresh vector of the same length as the bytes vector, containing the contents of the read buffer of the transmission.

See HANDLE
See MAX-SPEED
See BITS/WORD

Package

cl-spidev.

Source

wrapper.lisp.

Function: transmit (handle bytes speed-hz delay-usecs bits/word)

Perform a SPI transmission of the given byte sequence.

The array must be an unsigned-byte 8 array that is sharable. On most implementations that matter this will correspond to any simple-vector with element-type unsigned-byte 8.

The speed-hz, delay-usecs, and bits/word parameters are temp overrides for the device configuration during the transmission.

Returned is a fresh vector of the same length as the bytes vector, containing the contents of the read buffer of the transmission.

See CFFI:MAKE-SHAREABLE-BYTE-VECTOR

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: write (bytes handle &key start end)

Write a sequence of words to the SPIDEV device.

The bytes vector should contain unsigned-bytes of size up to the number of BITS/WORD of the handle.

The bytes written are automatically flushed to the spi device handle, so that when WRITE returns, the operation should have completed. If you need to manually control flushing or need to write in much smaller intervals, please refer to the low- level interface.

See HANDLE
See WRITE*

Package

cl-spidev.

Source

wrapper.lisp.

Function: write* (handle &rest bytes)

Writes the bytes in the arguments list to the SPIDEV device.

See WRITE

Package

cl-spidev.

Source

wrapper.lisp.

Function: write-bytes (bytes handle &key start end)

Writes the byte sequence to the SPIDEV device handle.

See LSB-FIRST
See BITS/WORD

Package

cl-spidev-lli.

Source

low-level.lisp.


5.1.5 Structures

Structure: handle

Struct to wrap a handle to a SPIDEV device and all of its associated information.

See OPEN
See CLOSE
See HANDLE
See MODE
See LSB-FIRST
See BITS/WORD
See MAX-SPEED
See READ
See READ*
See WRITE
See WRITE*

Package

cl-spidev.

Source

wrapper.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: stream
Package

common-lisp.

Type

stream

Initform

(make-broadcast-stream)

Readers

handle-stream.

Writers

This slot is read-only.

Slot: mode
Type

keyword

Initform

:unknown

Readers

handle-mode.

Writers

(setf handle-mode).

Slot: lsb-first
Type

boolean

Readers

handle-lsb-first.

Writers

(setf handle-lsb-first).

Slot: bits/word
Type

(unsigned-byte 8)

Initform

0

Readers

handle-bits/word.

Writers

(setf handle-bits/word).

Slot: max-speed
Type

(unsigned-byte 32)

Initform

0

Readers

handle-max-speed.

Writers

(setf handle-max-speed).


5.2 Internals


5.2.1 Constants

Constant: spi-cpha

Constant holding the value defined in the kernel constant SPI_CPHA.

Package

cl-spidev-lli.

Source

constants.lisp.


5.2.2 Symbol macros

Symbol Macro: *errno*
Package

cl-spidev-lli.

Source

ioctl.lisp.


5.2.3 Ordinary functions

Function: %ioctl (fd request data)
Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: %var-accessor-*errno* ()
Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: (setf %var-accessor-*errno*) ()
Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: copy-handle (instance)
Package

cl-spidev.

Source

wrapper.lisp.

Function: file-name (pathname)

Returns the full file name of the path.

Package

cl-spidev-lli.

Source

low-level.lisp.

Reader: handle-bits/word (instance)
Writer: (setf handle-bits/word) (instance)
Package

cl-spidev.

Source

wrapper.lisp.

Target Slot

bits/word.

Reader: handle-lsb-first (instance)
Writer: (setf handle-lsb-first) (instance)
Package

cl-spidev.

Source

wrapper.lisp.

Target Slot

lsb-first.

Reader: handle-max-speed (instance)
Writer: (setf handle-max-speed) (instance)
Package

cl-spidev.

Source

wrapper.lisp.

Target Slot

max-speed.

Reader: handle-mode (instance)
Writer: (setf handle-mode) (instance)
Package

cl-spidev.

Source

wrapper.lisp.

Target Slot

mode.

Function: handle-p (object)
Package

cl-spidev.

Source

wrapper.lisp.

Reader: handle-stream (instance)
Package

cl-spidev.

Source

wrapper.lisp.

Target Slot

stream.

Function: ioctl (fd cmd)

Accessor to perform an IOCTL command, which can either get or set an int value.

Use SETF to set a value.
Signals an error if the command failed.

This is available on the following implementations:
* SBCL
* CCL

Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: (setf ioctl) (fd cmd)
Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: make-handle (&key stream mode lsb-first bits/word max-speed)
Package

cl-spidev.

Source

wrapper.lisp.

Function: spidev-file (id)

Return an absolute path to the requested SPIDEV device.

See *SPIDEV-ROOT*

Package

cl-spidev-lli.

Source

low-level.lisp.

Function: stream-fd (fd)
Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: strerror (error)
Package

cl-spidev-lli.

Source

ioctl.lisp.

Function: xfer-bits/word (pointer-to-xfer)

Temporary override of the device’s wordsize.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-bits/word) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-cs-change (pointer-to-xfer)

True to deselect device before starting the next transfer.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-cs-change) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-delay-usecs (pointer-to-xfer)

If nonzero, how long to delay after the last bit transfer before optionally deselecting the device before the next transfer.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-delay-usecs) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-len (pointer-to-xfer)

Length of tx and rx buffers, in bytes.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-len) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-pad (pointer-to-xfer)

Unknown purpose, has to be set to zero.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-pad) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-rx-buf (pointer-to-xfer)

Holds pointer to userspace buffer for receive data, or null.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-rx-buf) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-rx-nbits (pointer-to-xfer)

Unknown purpose, has to be set to zero.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-rx-nbits) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-speed-hz (pointer-to-xfer)

Temporary override of the device’s bitrate.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-speed-hz) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-tx-buf (pointer-to-xfer)

Holds pointer to userspace buffer with transmit data, or null.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-tx-buf) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.

Function: xfer-tx-nbits (pointer-to-xfer)

Unknown purpose, has to be set to zero.

See XFER

Package

cl-spidev-lli.

Source

constants.lisp.

Function: (setf xfer-tx-nbits) (pointer-to-xfer)
Package

cl-spidev-lli.

Source

constants.lisp.


5.2.4 Classes

Class: xfer

Struct holding data for a transmission over the SPI.

See XFER-TX-BUF
See XFER-RX-BUF
See XFER-LEN
See XFER-SPEED-HZ
See XFER-DELAY-USECS
See XFER-BITS/WORD
See XFER-CS-CHANGE
See XFER-TX-NBITS
See XFER-RX-NBITS
See XFER-PAD

Package

cl-spidev-lli.

Source

constants.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
B   C   D   F   H   I   L   M   O   R   S   T   W   X  
Index Entry  Section

%
%ioctl: Private ordinary functions
%var-accessor-*errno*: Private ordinary functions

(
(setf %var-accessor-*errno*): Private ordinary functions
(setf bits/word): Public ordinary functions
(setf bits/word): Public ordinary functions
(setf handle-bits/word): Private ordinary functions
(setf handle-lsb-first): Private ordinary functions
(setf handle-max-speed): Private ordinary functions
(setf handle-mode): Private ordinary functions
(setf ioctl): Private ordinary functions
(setf lsb-first): Public ordinary functions
(setf lsb-first): Public ordinary functions
(setf max-speed): Public ordinary functions
(setf max-speed): Public ordinary functions
(setf mode): Public ordinary functions
(setf mode): Public ordinary functions
(setf xfer-bits/word): Private ordinary functions
(setf xfer-cs-change): Private ordinary functions
(setf xfer-delay-usecs): Private ordinary functions
(setf xfer-len): Private ordinary functions
(setf xfer-pad): Private ordinary functions
(setf xfer-rx-buf): Private ordinary functions
(setf xfer-rx-nbits): Private ordinary functions
(setf xfer-speed-hz): Private ordinary functions
(setf xfer-tx-buf): Private ordinary functions
(setf xfer-tx-nbits): Private ordinary functions

B
bits/word: Public ordinary functions
bits/word: Public ordinary functions

C
close: Public ordinary functions
close-spi: Public ordinary functions
copy-handle: Private ordinary functions

D
devices: Public ordinary functions

F
file-name: Private ordinary functions
Function, %ioctl: Private ordinary functions
Function, %var-accessor-*errno*: Private ordinary functions
Function, (setf %var-accessor-*errno*): Private ordinary functions
Function, (setf bits/word): Public ordinary functions
Function, (setf bits/word): Public ordinary functions
Function, (setf handle-bits/word): Private ordinary functions
Function, (setf handle-lsb-first): Private ordinary functions
Function, (setf handle-max-speed): Private ordinary functions
Function, (setf handle-mode): Private ordinary functions
Function, (setf ioctl): Private ordinary functions
Function, (setf lsb-first): Public ordinary functions
Function, (setf lsb-first): Public ordinary functions
Function, (setf max-speed): Public ordinary functions
Function, (setf max-speed): Public ordinary functions
Function, (setf mode): Public ordinary functions
Function, (setf mode): Public ordinary functions
Function, (setf xfer-bits/word): Private ordinary functions
Function, (setf xfer-cs-change): Private ordinary functions
Function, (setf xfer-delay-usecs): Private ordinary functions
Function, (setf xfer-len): Private ordinary functions
Function, (setf xfer-pad): Private ordinary functions
Function, (setf xfer-rx-buf): Private ordinary functions
Function, (setf xfer-rx-nbits): Private ordinary functions
Function, (setf xfer-speed-hz): Private ordinary functions
Function, (setf xfer-tx-buf): Private ordinary functions
Function, (setf xfer-tx-nbits): Private ordinary functions
Function, bits/word: Public ordinary functions
Function, bits/word: Public ordinary functions
Function, close: Public ordinary functions
Function, close-spi: Public ordinary functions
Function, copy-handle: Private ordinary functions
Function, devices: Public ordinary functions
Function, file-name: Private ordinary functions
Function, handle: Public ordinary functions
Function, handle-bits/word: Private ordinary functions
Function, handle-lsb-first: Private ordinary functions
Function, handle-max-speed: Private ordinary functions
Function, handle-mode: Private ordinary functions
Function, handle-p: Private ordinary functions
Function, handle-stream: Private ordinary functions
Function, ioctl: Private ordinary functions
Function, lsb-first: Public ordinary functions
Function, lsb-first: Public ordinary functions
Function, make-handle: Private ordinary functions
Function, max-speed: Public ordinary functions
Function, max-speed: Public ordinary functions
Function, mode: Public ordinary functions
Function, mode: Public ordinary functions
Function, open: Public ordinary functions
Function, open-spi: Public ordinary functions
Function, read: Public ordinary functions
Function, read*: Public ordinary functions
Function, read-bytes: Public ordinary functions
Function, spidev-file: Private ordinary functions
Function, stream-fd: Private ordinary functions
Function, strerror: Private ordinary functions
Function, transmit: Public ordinary functions
Function, transmit: Public ordinary functions
Function, write: Public ordinary functions
Function, write*: Public ordinary functions
Function, write-bytes: Public ordinary functions
Function, xfer-bits/word: Private ordinary functions
Function, xfer-cs-change: Private ordinary functions
Function, xfer-delay-usecs: Private ordinary functions
Function, xfer-len: Private ordinary functions
Function, xfer-pad: Private ordinary functions
Function, xfer-rx-buf: Private ordinary functions
Function, xfer-rx-nbits: Private ordinary functions
Function, xfer-speed-hz: Private ordinary functions
Function, xfer-tx-buf: Private ordinary functions
Function, xfer-tx-nbits: Private ordinary functions

H
handle: Public ordinary functions
handle-bits/word: Private ordinary functions
handle-lsb-first: Private ordinary functions
handle-max-speed: Private ordinary functions
handle-mode: Private ordinary functions
handle-p: Private ordinary functions
handle-stream: Private ordinary functions

I
ioctl: Private ordinary functions

L
lsb-first: Public ordinary functions
lsb-first: Public ordinary functions

M
Macro, with-open-spi: Public macros
make-handle: Private ordinary functions
max-speed: Public ordinary functions
max-speed: Public ordinary functions
mode: Public ordinary functions
mode: Public ordinary functions

O
open: Public ordinary functions
open-spi: Public ordinary functions

R
read: Public ordinary functions
read*: Public ordinary functions
read-bytes: Public ordinary functions

S
spidev-file: Private ordinary functions
stream-fd: Private ordinary functions
strerror: Private ordinary functions

T
transmit: Public ordinary functions
transmit: Public ordinary functions

W
with-open-spi: Public macros
write: Public ordinary functions
write*: Public ordinary functions
write-bytes: Public ordinary functions

X
xfer-bits/word: Private ordinary functions
xfer-cs-change: Private ordinary functions
xfer-delay-usecs: Private ordinary functions
xfer-len: Private ordinary functions
xfer-pad: Private ordinary functions
xfer-rx-buf: Private ordinary functions
xfer-rx-nbits: Private ordinary functions
xfer-speed-hz: Private ordinary functions
xfer-tx-buf: Private ordinary functions
xfer-tx-nbits: Private ordinary functions


A.3 Variables

Jump to:   *  
B   C   L   M   S  
Index Entry  Section

*
*errno*: Private symbol macros
*spidev-root*: Public special variables

B
bits/word: Public structures

C
Constant, spi-3wire: Public constants
Constant, spi-cpha: Private constants
Constant, spi-cpol: Public constants
Constant, spi-cs-high: Public constants
Constant, spi-ioc-message-1: Public constants
Constant, spi-ioc-rd-bits-per-word: Public constants
Constant, spi-ioc-rd-lsb-first: Public constants
Constant, spi-ioc-rd-max-speed-hz: Public constants
Constant, spi-ioc-rd-mode: Public constants
Constant, spi-ioc-rd-mode32: Public constants
Constant, spi-ioc-wr-bits-per-word: Public constants
Constant, spi-ioc-wr-lsb-first: Public constants
Constant, spi-ioc-wr-max-speed-hz: Public constants
Constant, spi-ioc-wr-mode: Public constants
Constant, spi-ioc-wr-mode32: Public constants
Constant, spi-loop: Public constants
Constant, spi-lsb-first: Public constants
Constant, spi-mode-0: Public constants
Constant, spi-mode-1: Public constants
Constant, spi-mode-2: Public constants
Constant, spi-mode-3: Public constants
Constant, spi-no-cs: Public constants
Constant, spi-ready: Public constants
Constant, spi-rx-dual: Public constants
Constant, spi-rx-quad: Public constants
Constant, spi-tx-dual: Public constants
Constant, spi-tx-quad: Public constants

L
lsb-first: Public structures

M
max-speed: Public structures
mode: Public structures

S
Slot, bits/word: Public structures
Slot, lsb-first: Public structures
Slot, max-speed: Public structures
Slot, mode: Public structures
Slot, stream: Public structures
Special Variable, *spidev-root*: Public special variables
spi-3wire: Public constants
spi-cpha: Private constants
spi-cpol: Public constants
spi-cs-high: Public constants
spi-ioc-message-1: Public constants
spi-ioc-rd-bits-per-word: Public constants
spi-ioc-rd-lsb-first: Public constants
spi-ioc-rd-max-speed-hz: Public constants
spi-ioc-rd-mode: Public constants
spi-ioc-rd-mode32: Public constants
spi-ioc-wr-bits-per-word: Public constants
spi-ioc-wr-lsb-first: Public constants
spi-ioc-wr-max-speed-hz: Public constants
spi-ioc-wr-mode: Public constants
spi-ioc-wr-mode32: Public constants
spi-loop: Public constants
spi-lsb-first: Public constants
spi-mode-0: Public constants
spi-mode-1: Public constants
spi-mode-2: Public constants
spi-mode-3: Public constants
spi-no-cs: Public constants
spi-ready: Public constants
spi-rx-dual: Public constants
spi-rx-quad: Public constants
spi-tx-dual: Public constants
spi-tx-quad: Public constants
stream: Public structures
Symbol Macro, *errno*: Private symbol macros