LXR linux/include/linux/iio/sysfs.h

   1/* The industrial I/O core
   2 *
   3 *Copyright (c) 2008 Jonathan Cameron
   4 *
   5 * This program is free software; you can redistribute it and/or modify it
   6 * under the terms of the GNU General Public License version 2 as published by
   7 * the Free Software Foundation.
   8 *
   9 * General attributes
  10 */
  11
  12#ifndef _INDUSTRIAL_IO_SYSFS_H_
  13#define _INDUSTRIAL_IO_SYSFS_H_
  14
  15struct iio_chan_spec;
  16
  17/**
  18 * struct iio_dev_attr - iio specific device attribute
  19 * @dev_attr:   underlying device attribute
  20 * @address:    associated register address
  21 * @l:          list head for maintaining list of dynamically created attrs
  22 * @c:          specification for the underlying channel
  23 */
  24struct iio_dev_attr {
  25        struct device_attribute dev_attr;
  26        u64 address;
  27        struct list_head l;
  28        struct iio_chan_spec const *c;
  29};
  30
  31#define to_iio_dev_attr(_dev_attr)                              \
  32        container_of(_dev_attr, struct iio_dev_attr, dev_attr)
  33
  34ssize_t iio_read_const_attr(struct device *dev,
  35                            struct device_attribute *attr,
  36                            char *len);
  37
  38/**
  39 * struct iio_const_attr - constant device specific attribute
  40 *                         often used for things like available modes
  41 * @string:     attribute string
  42 * @dev_attr:   underlying device attribute
  43 */
  44struct iio_const_attr {
  45        const char *string;
  46        struct device_attribute dev_attr;
  47};
  48
  49#define to_iio_const_attr(_dev_attr) \
  50        container_of(_dev_attr, struct iio_const_attr, dev_attr)
  51
  52/* Some attributes will be hard coded (device dependent) and not require an
  53   address, in these cases pass a negative */
  54#define IIO_ATTR(_name, _mode, _show, _store, _addr)            \
  55        { .dev_attr = __ATTR(_name, _mode, _show, _store),      \
  56          .address = _addr }
  57
  58#define IIO_DEVICE_ATTR(_name, _mode, _show, _store, _addr)     \
  59        struct iio_dev_attr iio_dev_attr_##_name                \
  60        = IIO_ATTR(_name, _mode, _show, _store, _addr)
  61
  62#define IIO_DEVICE_ATTR_NAMED(_vname, _name, _mode, _show, _store, _addr) \
  63        struct iio_dev_attr iio_dev_attr_##_vname                       \
  64        = IIO_ATTR(_name, _mode, _show, _store, _addr)
  65
  66#define IIO_CONST_ATTR(_name, _string)                                  \
  67        struct iio_const_attr iio_const_attr_##_name                    \
  68        = { .string = _string,                                          \
  69            .dev_attr = __ATTR(_name, S_IRUGO, iio_read_const_attr, NULL)}
  70
  71#define IIO_CONST_ATTR_NAMED(_vname, _name, _string)                    \
  72        struct iio_const_attr iio_const_attr_##_vname                   \
  73        = { .string = _string,                                          \
  74            .dev_attr = __ATTR(_name, S_IRUGO, iio_read_const_attr, NULL)}
  75
  76/* Generic attributes of onetype or another */
  77
  78/**
  79 * IIO_DEV_ATTR_SAMP_FREQ - sets any internal clock frequency
  80 * @_mode: sysfs file mode/permissions
  81 * @_show: output method for the attribute
  82 * @_store: input method for the attribute
  83 **/
  84#define IIO_DEV_ATTR_SAMP_FREQ(_mode, _show, _store)                    \
  85        IIO_DEVICE_ATTR(sampling_frequency, _mode, _show, _store, 0)
  86
  87/**
  88 * IIO_DEV_ATTR_SAMP_FREQ_AVAIL - list available sampling frequencies
  89 * @_show: output method for the attribute
  90 *
  91 * May be mode dependent on some devices
  92 **/
  93#define IIO_DEV_ATTR_SAMP_FREQ_AVAIL(_show)                             \
  94        IIO_DEVICE_ATTR(sampling_frequency_available, S_IRUGO, _show, NULL, 0)
  95/**
  96 * IIO_CONST_ATTR_SAMP_FREQ_AVAIL - list available sampling frequencies
  97 * @_string: frequency string for the attribute
  98 *
  99 * Constant version
 100 **/
 101#define IIO_CONST_ATTR_SAMP_FREQ_AVAIL(_string)                 \
 102        IIO_CONST_ATTR(sampling_frequency_available, _string)
 103
 104/**
 105 * IIO_DEV_ATTR_INT_TIME_AVAIL - list available integration times
 106 * @_show: output method for the attribute
 107 **/
 108#define IIO_DEV_ATTR_INT_TIME_AVAIL(_show)              \
 109        IIO_DEVICE_ATTR(integration_time_available, S_IRUGO, _show, NULL, 0)
 110/**
 111 * IIO_CONST_ATTR_INT_TIME_AVAIL - list available integration times
 112 * @_string: frequency string for the attribute
 113 *
 114 * Constant version
 115 **/
 116#define IIO_CONST_ATTR_INT_TIME_AVAIL(_string)          \
 117        IIO_CONST_ATTR(integration_time_available, _string)
 118
 119#define IIO_DEV_ATTR_TEMP_RAW(_show)                    \
 120        IIO_DEVICE_ATTR(in_temp_raw, S_IRUGO, _show, NULL, 0)
 121
 122#define IIO_CONST_ATTR_TEMP_OFFSET(_string)             \
 123        IIO_CONST_ATTR(in_temp_offset, _string)
 124
 125#define IIO_CONST_ATTR_TEMP_SCALE(_string)              \
 126        IIO_CONST_ATTR(in_temp_scale, _string)
 127
 128#endif /* _INDUSTRIAL_IO_SYSFS_H_ */
 129