Skip to content

Z
ZIO
Commit cbcdf2f7 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

Documentation/ABI: add ABI documentation 

Signed-off-by: 's avatarFederico Vaga <federico.vaga@gmail.com>
Acked-by: Alessandro Rubini's avatarAlessandro Rubini <rubini@gnudd.com>
parent ed05c54c
Hide whitespace changes
Inline Side-by-side
Showing with 295 additions and 0 deletions
Documentation/ABI/stable/sysfs-bus-zio 0 → 100644
View file @ cbcdf2f7
Where: /sys/bus/zio/version
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute return the version of the ZIO framework in use.
Users:
Where: /sys/bus/zio/available_buffers
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute return the list of available buffer types.
Users:
Where: /sys/bus/zio/available_triggers
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute return the list of available trigger types.
Users:
Where: /sys/bus/zio/devices/hw-<zdev>/
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This directory represents a fake instance of a device the
real device (<zdev>). Once the device match with a ZIO
driver, then it creates the real device directory.
Users:
Where: /sys/bus/zio/devices/<zdev>/
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This directory represents a real device; it is child of
the fake device. This is the highest level of the device
hierarchy.
Users:
Where: /sys/bus/zio/devices/<zdev>/name
/sys/bus/zio/devices/<zdev>/<cset>/name
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/name
/sys/bus/zio/devices/<zdev>/<cset>/trigger/name
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/buffer/name
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute returns the name of a ZIO object. It is a
read only attribute.
Users:
Where: /sys/bus/zio/devices/<zdev>/enable
/sys/bus/zio/devices/<zdev>/<cset>/enable
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/enable
/sys/bus/zio/devices/<zdev>/<cset>/trigger/enable
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/buffer/enable
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute enable/disable a ZIO object. To enable a
ZIO object you must write '1', to disable '0'
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/current_buffer
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute return the current buffer in use by the
channel within the channel-set. You can change the kind of
buffer by writing its name in this attribute.
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/current_trigger
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute return the current trigger in use by the
channel-set. You can change the kind of trigger by writing
its name in this attribute.
Users:
Documentation/ABI/stable/sysfs-bus-zio-buffer 0 → 100644
View file @ cbcdf2f7
Where: /sys/bus/zio/devices/<zdev>/<cset>/<chan>/buffer/
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This is a collection of ZIO buffer attributes. It
contains both: standard attributes (described later) and
extended attributes defined by each driver (not described
in this document). This collection refers to a single
instance of a buffer implementation. Each buffer
implementation can decide to support or not the standard
attributes; if it supports the standard attributes it
works as described in this document.
Finally, remember that there is a buffer instance of the
same implementation for each channel within the same
channel-set of your devices
Note: The permission on the standard attributes depend on
the buffer implementation
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/<chan>/buffer/version
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the version of the collection of
attributes that a buffer implementation exports. A
collection can change during the time. This attribute allow
an user-space program to recognize if it can work with a
particular version or not
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/<chan>/buffer/max-buffer-len
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the maximum number of blocks that
the buffer instance can store.
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/<chan>/buffer/max-buffer-kb
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the maximum kilo-byte of data (only
data not block) that the buffer instance can store.
Users:
Documentation/ABI/stable/sysfs-bus-zio-device 0 → 100644
View file @ cbcdf2f7
Where: /sys/bus/zio/devices/<zdev>/
/sys/bus/zio/devices/<zdev>/<cset>/
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: These are collections of attributes of the ZIO device
hierarchy. Each collection contains both: standard
attributes (described later) and extended attributes
defined by each driver (not described in this document).
A standard attribute can appear *only* one time in the
device hierarchy (e.g. The attribute X can be in a <cset>,
but it cannot be, at the same time, in a <chan> or a <zdev>
level). In this documentation we indicate each attribute
at all level, but remember that it can be available only
in one level. If an attribute appears only on a single
level it means that it can leave only there.
Attributes that live in an high level automatically apply
the configuration on all lower levels.
This collection refers to a single instance of a device.
Each driver can decide to support or not the standard
attributes; if it supports the standard attributes it works
as described in this document.
Note: The permission on the standard attributes depend on
the driver implementation
Users:
Where: /sys/bus/zio/devices/<zdev>/version
/sys/bus/zio/devices/<zdev>/<cset>/version
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/version
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the version of the collection of
attributes that a device driver exports. A
collection can change during the time. This attribute allow
an user-space program to recognize if it can work with a
particular version or not
Users:
Where: /sys/bus/zio/devices/<zdev>/gain_factor
/sys/bus/zio/devices/<zdev>/<cset>/gain_factor
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/gain_factor
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the gain factor of an I/O signal.
Users:
Where: /sys/bus/zio/devices/<zdev>/offset
/sys/bus/zio/devices/<zdev>/<cset>/offset
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/offset
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the offset to apply on an I/O
signal.
Users:
Where: /sys/bus/zio/devices/<zdev>/resolution-bits
/sys/bus/zio/devices/<zdev>/<cset>/resolution-bits
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/resolution-bits
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the resolution bit of a digitalized
I/O signal.
Users:
Where: /sys/bus/zio/devices/<zdev>/max-sample-rate
/sys/bus/zio/devices/<zdev>/<cset>/max-sample-rate
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/max-sample-rate
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the maximum sample rate of the I/O
signal.
Users:
Where: /sys/bus/zio/devices/<zdev>/vref-src
/sys/bus/zio/devices/<zdev>/<cset>/vref-src
/sys/bus/zio/devices/<zdev>/<cset>/<chan>/vref-src
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the Volt reference source for the I/O
signal.
Users:
Documentation/ABI/stable/sysfs-bus-zio-trigger 0 → 100644
View file @ cbcdf2f7
Where: /sys/bus/zio/devices/<zdev>/<cset>/trigger/
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This is a collection of ZIO trigger attributes. It
contains both: standard attributes (described later) and
extended attributes defined by each driver (not described
in this document). This collection refers to a single
instance of a trigger implementation. Each trigger
implementation can decide to support or not the standard
attributes; if it supports the standard attributes it
works as described in this document.
Finally, remember that there is a trigger instance of the
same implementation for each channel-set of your devices
Note: The permission on the standard attributes depend on
the trigger implementation
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/trigger/version
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the version of the collection of
attributes that a trigger implementation exports. A
collection can change during the time. This attribute allow
an user-space program to recognize if it can work with a
particular version or not
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/trigger/nshots
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the number of consecutive shots that
a trigger must perform. The value '0' mean infinite; not
all trigger implementation supports this feature. If a
trigger does not support infinite shots, it must prevents
the user to set '0' in this attribute.
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/trigger/pre-samples
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the number of pre-samples acquire for
each programmed shots.
Users:
Where: /sys/bus/zio/devices/<zdev>/<cset>/trigger/post-samples
Date: April 2013
Kernel Version: 3.x
Contact: zio@ohwr.org (mailing list)
Description: This attribute define the number of post-samples acquire for
each programmed shots.
Users:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment