Liking cljdoc? Tell your friends :D

dvlopt.linux.i2c.smbus

The SMBus protocol is more or less a subset of I2C. Quite often, SMBus operations can be carried out on an I2C bus. In consequence, the Linux kernel provides SMBus operation defined in the standard.

Those operations performs common interactions. Single byte can be exchanged, as well as words (2 bytes) and blocks (at most 32 bytes at a time). The term "command" refers to what is also called a "register".

Not every operation is supported by your driver and supported ones might fail with some inadapted slaves.

The SMBus protocol is more or less a subset of I2C. Quite often, SMBus operations can be carried
out on an I2C bus. In consequence, the Linux kernel provides SMBus operation defined in the standard.

Those operations performs common interactions. Single byte can be exchanged, as well as words (2 bytes)
and blocks (at most 32 bytes at a time). The term "command" refers to what is also called a "register".

Not every operation is supported by your driver and supported ones might fail with some inadapted slaves.
raw docstring

block-process-callclj

(block-process-call bus command bs)

Performs a multi-byte process call by writing a block acting as an argument and then reading a block acting as the result.

Cf. dvlopt.linux.i2c/capabilities for the :block-process-call capability.

Performs a multi-byte process call by writing a block acting as an argument and then reading a block acting as the result.

Cf. `dvlopt.linux.i2c/capabilities` for the :block-process-call capability.
sourceraw docstring

process-callclj

(process-call bus command w)

Performs a simple process call by writing a word acting as an argument and then reading a word acting as the result.

Cf. dvlopt.linux.i2c/capabilities for the :process-call capability.

Performs a simple process call by writing a word acting as an argument and then reading a word acting as the result.

Cf. `dvlopt.linux.i2c/capabilities` for the :process-call capability.
sourceraw docstring

quick-readclj

(quick-read bus)

Sends a read message without any content.

Cf. dvlopt.linux.i2c/capabilities for the :quick capability.

Sends a read message without any content.

Cf. `dvlopt.linux.i2c/capabilities` for the :quick capability.
sourceraw docstring

quick-writeclj

(quick-write bus)

Sends a write message without any content.

Cf. dvlopt.linux.i2c/capabilities for the :quick capability.

Sends a write message without any content.

Cf. `dvlopt.linux.i2c/capabilities` for the :quick capability.
sourceraw docstring

read-blockclj

(read-block bus command)

Reads a block after specifying a command.

Cf. dvlopt.linux.i2c/capabilities for the :read-block capability.

Reads a block after specifying a command.

Cf. `dvlopt.linux.i2c/capabilities` for the :read-block capability.
sourceraw docstring

read-byteclj

(read-byte bus command)

Reads a byte after specifying a command.

Cf. dvlopt.linux.i2c/capabilities for the :read-byte capability.

Reads a byte after specifying a command.

Cf. `dvlopt.linux.i2c/capabilities` for the :read-byte capability.
sourceraw docstring

read-byte-directlyclj

(read-byte-directly bus)

Reads a single byte.

Cf. dvlopt.linux.i2c/capabilities for the :read-byte-directly capability.

Reads a single byte.

Cf. `dvlopt.linux.i2c/capabilities` for the :read-byte-directly capability.
sourceraw docstring

read-i2c-blockclj

(read-i2c-block bus command length)

Reads a block of chosen length after specifying a command.

Not standard but often encountered and supported.

Cf. dvlopt.linux.i2c/capabilities for the :read-i2c-block capability.

Reads a block of chosen length after specifying a command.

Not standard but often encountered and supported.

Cf. `dvlopt.linux.i2c/capabilities` for the :read-i2c-block capability.
sourceraw docstring

read-wordclj

(read-word bus command)

Read a word after specifying a command.

Cf. dvlopt.linux.i2c/capabilities for the :read-word capability.

Read a word after specifying a command.

Cf. `dvlopt.linux.i2c/capabilities` for the :read-word capability.
sourceraw docstring

write-blockclj

(write-block bus command bs)

Writes a block after specifying a command as well as the number of bytes in the block.

Cf. dvlopt.linux.i2c/capabilities for the :write-block capability.

Writes a block after specifying a command as well as the number of bytes in the block.

Cf. `dvlopt.linux.i2c/capabilities` for the :write-block capability.
sourceraw docstring

write-byteclj

(write-byte bus command b)

Write a byte after specifying a command.

Cf. dvlopt.linux.i2c/capabilities for the :write-byte capability.

Write a byte after specifying a command.

Cf. `dvlopt.linux.i2c/capabilities` for the :write-byte capability.
sourceraw docstring

write-byte-directlyclj

(write-byte-directly bus b)

Writes a single byte.

Cf. dvlopt.linux.i2c/capabilities for the :write-byte-directly capability.

Writes a single byte.

Cf. `dvlopt.linux.i2c/capabilities` for the :write-byte-directly capability.
sourceraw docstring

write-i2c-blockclj

(write-i2c-block bus command bs)

Writes a block after specifying a command.

Unlike write-block, does not send a byte count.

Not standard but often encountered and supported.

Cf. dvlopt.linux.i2c/capabilities for the :write-i2c-block capability.

Writes a block after specifying a command.

Unlike `write-block`, does not send a byte count.

Not standard but often encountered and supported.

Cf. `dvlopt.linux.i2c/capabilities` for the :write-i2c-block capability.
sourceraw docstring

write-wordclj

(write-word bus command w)

Writes a word after specifying a command.

Cf. dvlopt.linux.i2c/capabilities for the :write-word capability.

Writes a word after specifying a command.

Cf. `dvlopt.linux.i2c/capabilities` for the :write-word capability.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close