The cl-spidev Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-spidev Reference Manual

This is the cl-spidev Reference Manual, version 1.1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:33:48 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

About cl-spidev

This is a bindings library for the Linux SPIDEV kernel module as described on https://www.kernel.org/doc/Documentation/spi/spidev. It provides both direct low-level, and high-level convenient access.

How To

List all the available SPIDEV devices.

(spidev:devices)

Create a handle object to one of them.

(defvar *handle* (spidev:open "0.0"))

You can then read out the current information of the device.

(spidev:mode *handle*)
(spidev:lsb-first *handle*)
(spidev:bits/word *handle*)
(spidev:max-speed *handle*)

You can also set the above places to the values you need them to be. See the respective docstrings.

Finally you can read from and write to the device.

(spidev:read* 12 *handle*)
(spidev:write* *handle* 1 2 3 4)

Once you are done you can either close the handle explicitly...

(spidev:close *handle*)

Or simply lose all references to it and wait for the GC to take care of it for you. Either way, it should be safe.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-spidev

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

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

License

Artistic

Description

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

Version

1.1.0

Dependencies
Source

cl-spidev.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-spidev.asd

Location

cl-spidev.asd

Systems

cl-spidev (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-spidev/package.lisp

Parent

cl-spidev (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-spidev/ioctl.lisp

Dependency

package.lisp (file)

Parent

cl-spidev (system)

Location

ioctl.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-spidev/constants.lisp

Dependency

ioctl.lisp (file)

Parent

cl-spidev (system)

Location

constants.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-spidev/low-level.lisp

Dependency

constants.lisp (file)

Parent

cl-spidev (system)

Location

low-level.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 cl-spidev/wrapper.lisp

Dependency

low-level.lisp (file)

Parent

cl-spidev (system)

Location

wrapper.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.7 cl-spidev/documentation.lisp

Dependency

wrapper.lisp (file)

Parent

cl-spidev (system)

Location

documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-spidev

Source

package.lisp (file)

Nicknames
Use List

common-lisp

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.2 cl-spidev-lli

Source

package.lisp (file)

Nickname

org.shirakumo.spidev.lli

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Constant: spi-cpol

Constant holding the value defined in the kernel constant SPI_CPOL.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-cs-high

Constant holding the value defined in the kernel constant SPI_CS_HIGH.

Package

cl-spidev-lli

Source

constants.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

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 (file)

Constant: spi-loop

Constant holding the value defined in the kernel constant SPI_LOOP.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-lsb-first

Constant holding the value defined in the kernel constant SPI_LSB_FIRST.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-mode-0

Constant holding the value defined in the kernel constant SPI_MODE_0.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-mode-1

Constant holding the value defined in the kernel constant SPI_MODE_1.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-mode-2

Constant holding the value defined in the kernel constant SPI_MODE_2.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-mode-3

Constant holding the value defined in the kernel constant SPI_MODE_3.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-no-cs

Constant holding the value defined in the kernel constant SPI_NO_CS.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-ready

Constant holding the value defined in the kernel constant SPI_READY.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-rx-dual

Constant holding the value defined in the kernel constant SPI_RX_DUAL.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-rx-quad

Constant holding the value defined in the kernel constant SPI_RX_QUAD.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-tx-dual

Constant holding the value defined in the kernel constant SPI_TX_DUAL.

Package

cl-spidev-lli

Source

constants.lisp (file)

Constant: spi-tx-quad

Constant holding the value defined in the kernel constant SPI_TX_QUAD.

Package

cl-spidev-lli

Source

constants.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Functions

Function: 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

Source

wrapper.lisp (file)

Writer

(setf bits/word) (function)

Function: (setf bits/word) VALUE HANDLE
Package

cl-spidev

Source

wrapper.lisp (file)

Reader

bits/word (function)

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 (file)

Writer

(setf bits/word) (function)

Function: (setf bits/word) BITS HANDLE
Package

cl-spidev-lli

Source

low-level.lisp (file)

Reader

bits/word (function)

Function: close HANDLE

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

See HANDLE

Package

cl-spidev

Source

wrapper.lisp (file)

Function: close-spi HANDLE

Close a handle to a SPIDEV device.

See WITH-OPEN-SPI

Package

cl-spidev-lli

Source

low-level.lisp (file)

Function: devices ()

Return a list of available SPIDEV devices on the system.

Package

cl-spidev-lli

Source

low-level.lisp (file)

Function: 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

Source

wrapper.lisp (file)

Function: lsb-first INSTANCE

Accessor to whether the least significant byte comes first.

Should be a boolean.

See HANDLE

Package

cl-spidev

Source

wrapper.lisp (file)

Writer

(setf lsb-first) (function)

Function: (setf lsb-first) VALUE HANDLE
Package

cl-spidev

Source

wrapper.lisp (file)

Reader

lsb-first (function)

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 (file)

Writer

(setf lsb-first) (function)

Function: (setf lsb-first) VALUE HANDLE
Package

cl-spidev-lli

Source

low-level.lisp (file)

Reader

lsb-first (function)

Function: 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

Source

wrapper.lisp (file)

Writer

(setf max-speed) (function)

Function: (setf max-speed) VALUE HANDLE
Package

cl-spidev

Source

wrapper.lisp (file)

Reader

max-speed (function)

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 (file)

Writer

(setf max-speed) (function)

Function: (setf max-speed) VALUE HANDLE
Package

cl-spidev-lli

Source

low-level.lisp (file)

Reader

max-speed (function)

Function: 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

Source

wrapper.lisp (file)

Writer

(setf mode) (function)

Function: (setf mode) VALUE HANDLE
Package

cl-spidev

Source

wrapper.lisp (file)

Reader

mode (function)

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 (file)

Writer

(setf mode) (function)

Function: (setf mode) MODE HANDLE
Package

cl-spidev-lli

Source

low-level.lisp (file)

Reader

mode (function)

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 (file)

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 (file)

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 (file)

Function: read* N HANDLE

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

See READ

Package

cl-spidev

Source

wrapper.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Function: write* HANDLE &rest BYTES

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

See WRITE

Package

cl-spidev

Source

wrapper.lisp (file)

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: stream
Type

stream

Initform

(make-broadcast-stream)

Readers

handle-stream (function)

Writers

(setf handle-stream) (function)

Slot: mode
Type

keyword

Initform

:unknown

Readers

handle-mode (function)

Writers

(setf handle-mode) (function)

Slot: lsb-first
Type

boolean

Readers

handle-lsb-first (function)

Writers

(setf handle-lsb-first) (function)

Slot: bits/word
Type

(unsigned-byte 8)

Initform

0

Readers

handle-bits/word (function)

Writers

(setf handle-bits/word) (function)

Slot: max-speed
Type

(unsigned-byte 32)

Initform

0

Readers

handle-max-speed (function)

Writers

(setf handle-max-speed) (function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Symbol macros

Symbol Macro: *errno*
Package

cl-spidev-lli

Source

ioctl.lisp (file)

Expansion

(cl-spidev-lli::%var-accessor-*errno*)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: %ioctl FD REQUEST DATA
Package

cl-spidev-lli

Source

ioctl.lisp (file)

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

cl-spidev-lli

Source

ioctl.lisp (file)

Function: copy-handle INSTANCE
Package

cl-spidev

Source

wrapper.lisp (file)

Function: file-name PATHNAME

Returns the full file name of the path.

Package

cl-spidev-lli

Source

low-level.lisp (file)

Function: handle-bits/word INSTANCE
Function: (setf handle-bits/word) VALUE INSTANCE
Package

cl-spidev

Source

wrapper.lisp (file)

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

cl-spidev

Source

wrapper.lisp (file)

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

cl-spidev

Source

wrapper.lisp (file)

Function: handle-mode INSTANCE
Function: (setf handle-mode) VALUE INSTANCE
Package

cl-spidev

Source

wrapper.lisp (file)

Function: handle-p OBJECT
Package

cl-spidev

Source

wrapper.lisp (file)

Function: handle-stream INSTANCE
Package

cl-spidev

Source

wrapper.lisp (file)

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 (file)

Writer

(setf ioctl) (function)

Function: (setf ioctl) ARG FD CMD
Package

cl-spidev-lli

Source

ioctl.lisp (file)

Reader

ioctl (function)

Function: make-handle &key (STREAM STREAM) (MODE MODE) (LSB-FIRST LSB-FIRST) (BITS/WORD BITS/WORD) (MAX-SPEED MAX-SPEED)
Package

cl-spidev

Source

wrapper.lisp (file)

Function: spidev-file ID

Return an absolute path to the requested SPIDEV device.

See *SPIDEV-ROOT*

Package

cl-spidev-lli

Source

low-level.lisp (file)

Function: stream-fd FD
Package

cl-spidev-lli

Source

ioctl.lisp (file)

Function: strerror ERROR
Package

cl-spidev-lli

Source

ioctl.lisp (file)

Function: xfer-bits/word POINTER-TO-XFER

Temporary override of the device’s wordsize.

See XFER

Package

cl-spidev-lli

Source

constants.lisp (file)

Writer

(setf xfer-bits/word) (function)

Function: (setf xfer-bits/word) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-bits/word (function)

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 (file)

Writer

(setf xfer-cs-change) (function)

Function: (setf xfer-cs-change) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-cs-change (function)

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 (file)

Writer

(setf xfer-delay-usecs) (function)

Function: (setf xfer-delay-usecs) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-delay-usecs (function)

Function: xfer-len POINTER-TO-XFER

Length of tx and rx buffers, in bytes.

See XFER

Package

cl-spidev-lli

Source

constants.lisp (file)

Writer

(setf xfer-len) (function)

Function: (setf xfer-len) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-len (function)

Function: xfer-pad POINTER-TO-XFER

Unknown purpose, has to be set to zero.

See XFER

Package

cl-spidev-lli

Source

constants.lisp (file)

Writer

(setf xfer-pad) (function)

Function: (setf xfer-pad) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-pad (function)

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 (file)

Writer

(setf xfer-rx-buf) (function)

Function: (setf xfer-rx-buf) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-rx-buf (function)

Function: xfer-rx-nbits POINTER-TO-XFER

Unknown purpose, has to be set to zero.

See XFER

Package

cl-spidev-lli

Source

constants.lisp (file)

Writer

(setf xfer-rx-nbits) (function)

Function: (setf xfer-rx-nbits) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-rx-nbits (function)

Function: xfer-speed-hz POINTER-TO-XFER

Temporary override of the device’s bitrate.

See XFER

Package

cl-spidev-lli

Source

constants.lisp (file)

Writer

(setf xfer-speed-hz) (function)

Function: (setf xfer-speed-hz) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-speed-hz (function)

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 (file)

Writer

(setf xfer-tx-buf) (function)

Function: (setf xfer-tx-buf) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-tx-buf (function)

Function: xfer-tx-nbits POINTER-TO-XFER

Unknown purpose, has to be set to zero.

See XFER

Package

cl-spidev-lli

Source

constants.lisp (file)

Writer

(setf xfer-tx-nbits) (function)

Function: (setf xfer-tx-nbits) VALUE POINTER-TO-XFER
Package

cl-spidev-lli

Source

constants.lisp (file)

Reader

xfer-tx-nbits (function)


Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-spidev.asd: The cl-spidev<dot>asd file
cl-spidev/constants.lisp: The cl-spidev/constants<dot>lisp file
cl-spidev/documentation.lisp: The cl-spidev/documentation<dot>lisp file
cl-spidev/ioctl.lisp: The cl-spidev/ioctl<dot>lisp file
cl-spidev/low-level.lisp: The cl-spidev/low-level<dot>lisp file
cl-spidev/package.lisp: The cl-spidev/package<dot>lisp file
cl-spidev/wrapper.lisp: The cl-spidev/wrapper<dot>lisp file

F
File, Lisp, cl-spidev.asd: The cl-spidev<dot>asd file
File, Lisp, cl-spidev/constants.lisp: The cl-spidev/constants<dot>lisp file
File, Lisp, cl-spidev/documentation.lisp: The cl-spidev/documentation<dot>lisp file
File, Lisp, cl-spidev/ioctl.lisp: The cl-spidev/ioctl<dot>lisp file
File, Lisp, cl-spidev/low-level.lisp: The cl-spidev/low-level<dot>lisp file
File, Lisp, cl-spidev/package.lisp: The cl-spidev/package<dot>lisp file
File, Lisp, cl-spidev/wrapper.lisp: The cl-spidev/wrapper<dot>lisp file

L
Lisp File, cl-spidev.asd: The cl-spidev<dot>asd file
Lisp File, cl-spidev/constants.lisp: The cl-spidev/constants<dot>lisp file
Lisp File, cl-spidev/documentation.lisp: The cl-spidev/documentation<dot>lisp file
Lisp File, cl-spidev/ioctl.lisp: The cl-spidev/ioctl<dot>lisp file
Lisp File, cl-spidev/low-level.lisp: The cl-spidev/low-level<dot>lisp file
Lisp File, cl-spidev/package.lisp: The cl-spidev/package<dot>lisp file
Lisp File, cl-spidev/wrapper.lisp: The cl-spidev/wrapper<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

%
%ioctl: Internal functions
%var-accessor-*errno*: Internal functions

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

B
bits/word: Exported functions
bits/word: Exported functions

C
close: Exported functions
close-spi: Exported functions
copy-handle: Internal functions

D
devices: Exported functions

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

H
handle: Exported functions
handle-bits/word: Internal functions
handle-lsb-first: Internal functions
handle-max-speed: Internal functions
handle-mode: Internal functions
handle-p: Internal functions
handle-stream: Internal functions

I
ioctl: Internal functions

L
lsb-first: Exported functions
lsb-first: Exported functions

M
Macro, with-open-spi: Exported macros
make-handle: Internal functions
max-speed: Exported functions
max-speed: Exported functions
mode: Exported functions
mode: Exported functions

O
open: Exported functions
open-spi: Exported functions

R
read: Exported functions
read*: Exported functions
read-bytes: Exported functions

S
spidev-file: Internal functions
stream-fd: Internal functions
strerror: Internal functions

T
transmit: Exported functions
transmit: Exported functions

W
with-open-spi: Exported macros
write: Exported functions
write*: Exported functions
write-bytes: Exported functions

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

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

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

*
*errno*: Internal symbol macros
*spidev-root*: Exported special variables

B
bits/word: Exported structures

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

L
lsb-first: Exported structures

M
max-speed: Exported structures
mode: Exported structures

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

Jump to:   *  
B   C   L   M   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   H   P   S   X  
Index Entry  Section

C
cl-spidev: The cl-spidev system
cl-spidev: The cl-spidev package
cl-spidev-lli: The cl-spidev-lli package
Class, xfer: Internal classes

H
handle: Exported structures

P
Package, cl-spidev: The cl-spidev package
Package, cl-spidev-lli: The cl-spidev-lli package

S
Structure, handle: Exported structures
System, cl-spidev: The cl-spidev system

X
xfer: Internal classes

Jump to:   C   H   P   S   X