diff options
Diffstat (limited to 'drivers/staging/fieldbus/Documentation/ABI')
| -rw-r--r-- | drivers/staging/fieldbus/Documentation/ABI/fieldbus-dev-cdev | 31 | ||||
| -rw-r--r-- | drivers/staging/fieldbus/Documentation/ABI/sysfs-class-fieldbus-dev | 62 |
2 files changed, 93 insertions, 0 deletions
diff --git a/drivers/staging/fieldbus/Documentation/ABI/fieldbus-dev-cdev b/drivers/staging/fieldbus/Documentation/ABI/fieldbus-dev-cdev new file mode 100644 index 000000000000..45f631ea32a6 --- /dev/null +++ b/drivers/staging/fieldbus/Documentation/ABI/fieldbus-dev-cdev @@ -0,0 +1,31 @@ +What: /dev/fieldbus_devX +Date: December 2018 +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + The cdev interface to drivers for Fieldbus Device Memory + (aka. Process Memory). + + The following file operations are supported: + + open(2) + Create an I/O context associated with the file descriptor. + + read(2) + Read from Process Memory's "read area". + Clears POLLERR | POLLPRI from the file descriptor. + + write(2) + Write to Process Memory's "write area". + + poll(2), select(2), epoll_wait(2) etc. + When a "Process Memory Read Area Changed" event occurs, + POLLERR | POLLPRI will be set on the file descriptor. + Note that POLLIN | POLLOUT events are always set, because the + process memory area is always readable and writable. + + close(2) + Free up the I/O context that was associated + with the file descriptor. + +Users: TBD diff --git a/drivers/staging/fieldbus/Documentation/ABI/sysfs-class-fieldbus-dev b/drivers/staging/fieldbus/Documentation/ABI/sysfs-class-fieldbus-dev new file mode 100644 index 000000000000..439f14d33c3b --- /dev/null +++ b/drivers/staging/fieldbus/Documentation/ABI/sysfs-class-fieldbus-dev @@ -0,0 +1,62 @@ +What: /sys/class/fieldbus_dev/fieldbus_devX/card_name +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + Human-readable name of the Fieldbus Device. + +What: /sys/class/fieldbus_dev/fieldbus_devX/fieldbus_type +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + The type of fieldbus implemented by this device. + Possible values: + 'unknown' + 'profinet' + +What: /sys/class/fieldbus_dev/fieldbus_devX/fieldbus_id +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + The unique fieldbus id associated with this device. + The exact format of this id is fieldbus type dependent, e.g. + a mac address for profinet. + +What: /sys/class/fieldbus_dev/fieldbus_devX/read_area_size +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + The size, in bytes, of the Process Memory read area. + Note: this area is accessible by reading from the associated + character device (/dev/fieldbus_devX). + +What: /sys/class/fieldbus_dev/fieldbus_devX/write_area_size +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + The size, in bytes, of the Process Memory write area. + Note: this area is accessible by writing to the associated + character device (/dev/fieldbus_devX) + +What: /sys/class/fieldbus_dev/fieldbus_devX/online +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + Whether the fieldbus is online or offline. + Possible values: + '1' meaning 'online' + '0' meaning 'offline' + Note: an uevent is generated when this property changes. + +What: /sys/class/fieldbus_dev/fieldbus_devX/enabled +KernelVersion: 5.1 (staging) +Contact: Sven Van Asbroeck <TheSven73@gmail.com> +Description: + Whether the device is enabled (power on) or + disabled (power off). + Possible values: + '1' meaning enabled + '0' meaning disabled + Normally a r/o property, but optionally r/w: + Writing '1' enables the device (power on) with default + settings. + Writing '0' disables the card (power off). |