1e65c26f4SWilliam Breathitt Gray /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2e65c26f4SWilliam Breathitt Gray /* 3e65c26f4SWilliam Breathitt Gray * Userspace ABI for Counter character devices 4e65c26f4SWilliam Breathitt Gray * Copyright (C) 2020 William Breathitt Gray 5e65c26f4SWilliam Breathitt Gray */ 6e65c26f4SWilliam Breathitt Gray #ifndef _UAPI_COUNTER_H_ 7e65c26f4SWilliam Breathitt Gray #define _UAPI_COUNTER_H_ 8e65c26f4SWilliam Breathitt Gray 9b6c50affSWilliam Breathitt Gray #include <linux/ioctl.h> 10b6c50affSWilliam Breathitt Gray #include <linux/types.h> 11b6c50affSWilliam Breathitt Gray 12b6c50affSWilliam Breathitt Gray /* Component type definitions */ 13b6c50affSWilliam Breathitt Gray enum counter_component_type { 14b6c50affSWilliam Breathitt Gray COUNTER_COMPONENT_NONE, 15b6c50affSWilliam Breathitt Gray COUNTER_COMPONENT_SIGNAL, 16b6c50affSWilliam Breathitt Gray COUNTER_COMPONENT_COUNT, 17b6c50affSWilliam Breathitt Gray COUNTER_COMPONENT_FUNCTION, 18b6c50affSWilliam Breathitt Gray COUNTER_COMPONENT_SYNAPSE_ACTION, 19b6c50affSWilliam Breathitt Gray COUNTER_COMPONENT_EXTENSION, 20b6c50affSWilliam Breathitt Gray }; 21b6c50affSWilliam Breathitt Gray 22e65c26f4SWilliam Breathitt Gray /* Component scope definitions */ 23e65c26f4SWilliam Breathitt Gray enum counter_scope { 24e65c26f4SWilliam Breathitt Gray COUNTER_SCOPE_DEVICE, 25e65c26f4SWilliam Breathitt Gray COUNTER_SCOPE_SIGNAL, 26e65c26f4SWilliam Breathitt Gray COUNTER_SCOPE_COUNT, 27e65c26f4SWilliam Breathitt Gray }; 28e65c26f4SWilliam Breathitt Gray 29b6c50affSWilliam Breathitt Gray /** 30b6c50affSWilliam Breathitt Gray * struct counter_component - Counter component identification 31b6c50affSWilliam Breathitt Gray * @type: component type (one of enum counter_component_type) 32b6c50affSWilliam Breathitt Gray * @scope: component scope (one of enum counter_scope) 33b6c50affSWilliam Breathitt Gray * @parent: parent ID (matching the ID suffix of the respective parent sysfs 34b6c50affSWilliam Breathitt Gray * path as described by the ABI documentation file 35b6c50affSWilliam Breathitt Gray * Documentation/ABI/testing/sysfs-bus-counter) 36b6c50affSWilliam Breathitt Gray * @id: component ID (matching the ID provided by the respective *_component_id 37b6c50affSWilliam Breathitt Gray * sysfs attribute of the desired component) 38b6c50affSWilliam Breathitt Gray * 39b6c50affSWilliam Breathitt Gray * For example, if the Count 2 ceiling extension of Counter device 4 is desired, 40b6c50affSWilliam Breathitt Gray * set type equal to COUNTER_COMPONENT_EXTENSION, scope equal to 417904cdf1SFabrice Gasnier * COUNTER_SCOPE_COUNT, parent equal to 2, and id equal to the value provided by 42b6c50affSWilliam Breathitt Gray * the respective /sys/bus/counter/devices/counter4/count2/ceiling_component_id 43b6c50affSWilliam Breathitt Gray * sysfs attribute. 44b6c50affSWilliam Breathitt Gray */ 45b6c50affSWilliam Breathitt Gray struct counter_component { 46b6c50affSWilliam Breathitt Gray __u8 type; 47b6c50affSWilliam Breathitt Gray __u8 scope; 48b6c50affSWilliam Breathitt Gray __u8 parent; 49b6c50affSWilliam Breathitt Gray __u8 id; 50b6c50affSWilliam Breathitt Gray }; 51b6c50affSWilliam Breathitt Gray 52b6c50affSWilliam Breathitt Gray /* Event type definitions */ 53b6c50affSWilliam Breathitt Gray enum counter_event_type { 54b6c50affSWilliam Breathitt Gray /* Count value increased past ceiling */ 55b6c50affSWilliam Breathitt Gray COUNTER_EVENT_OVERFLOW, 56b6c50affSWilliam Breathitt Gray /* Count value decreased past floor */ 57b6c50affSWilliam Breathitt Gray COUNTER_EVENT_UNDERFLOW, 58b6c50affSWilliam Breathitt Gray /* Count value increased past ceiling, or decreased past floor */ 59b6c50affSWilliam Breathitt Gray COUNTER_EVENT_OVERFLOW_UNDERFLOW, 60b6c50affSWilliam Breathitt Gray /* Count value reached threshold */ 61b6c50affSWilliam Breathitt Gray COUNTER_EVENT_THRESHOLD, 62b6c50affSWilliam Breathitt Gray /* Index signal detected */ 63b6c50affSWilliam Breathitt Gray COUNTER_EVENT_INDEX, 6473799a88SOleksij Rempel /* State of counter is changed */ 6573799a88SOleksij Rempel COUNTER_EVENT_CHANGE_OF_STATE, 6645d29185SWilliam Breathitt Gray /* Count value captured */ 6745d29185SWilliam Breathitt Gray COUNTER_EVENT_CAPTURE, 68*a1cd3395SDavid Lechner /* Direction change detected */ 69*a1cd3395SDavid Lechner COUNTER_EVENT_DIRECTION_CHANGE, 70b6c50affSWilliam Breathitt Gray }; 71b6c50affSWilliam Breathitt Gray 72b6c50affSWilliam Breathitt Gray /** 73b6c50affSWilliam Breathitt Gray * struct counter_watch - Counter component watch configuration 74b6c50affSWilliam Breathitt Gray * @component: component to watch when event triggers 75b6c50affSWilliam Breathitt Gray * @event: event that triggers (one of enum counter_event_type) 76b6c50affSWilliam Breathitt Gray * @channel: event channel (typically 0 unless the device supports concurrent 77b6c50affSWilliam Breathitt Gray * events of the same type) 78b6c50affSWilliam Breathitt Gray */ 79b6c50affSWilliam Breathitt Gray struct counter_watch { 80b6c50affSWilliam Breathitt Gray struct counter_component component; 81b6c50affSWilliam Breathitt Gray __u8 event; 82b6c50affSWilliam Breathitt Gray __u8 channel; 83b6c50affSWilliam Breathitt Gray }; 84b6c50affSWilliam Breathitt Gray 85b6c50affSWilliam Breathitt Gray /* 86b6c50affSWilliam Breathitt Gray * Queues a Counter watch for the specified event. 87b6c50affSWilliam Breathitt Gray * 88b6c50affSWilliam Breathitt Gray * The queued watches will not be applied until COUNTER_ENABLE_EVENTS_IOCTL is 89b6c50affSWilliam Breathitt Gray * called. 90b6c50affSWilliam Breathitt Gray */ 91b6c50affSWilliam Breathitt Gray #define COUNTER_ADD_WATCH_IOCTL _IOW(0x3E, 0x00, struct counter_watch) 92b6c50affSWilliam Breathitt Gray /* 93b6c50affSWilliam Breathitt Gray * Enables monitoring the events specified by the Counter watches that were 94b6c50affSWilliam Breathitt Gray * queued by COUNTER_ADD_WATCH_IOCTL. 95b6c50affSWilliam Breathitt Gray * 96b6c50affSWilliam Breathitt Gray * If events are already enabled, the new set of watches replaces the old one. 97b6c50affSWilliam Breathitt Gray * Calling this ioctl also has the effect of clearing the queue of watches added 98b6c50affSWilliam Breathitt Gray * by COUNTER_ADD_WATCH_IOCTL. 99b6c50affSWilliam Breathitt Gray */ 100b6c50affSWilliam Breathitt Gray #define COUNTER_ENABLE_EVENTS_IOCTL _IO(0x3E, 0x01) 101b6c50affSWilliam Breathitt Gray /* 102b6c50affSWilliam Breathitt Gray * Stops monitoring the previously enabled events. 103b6c50affSWilliam Breathitt Gray */ 104b6c50affSWilliam Breathitt Gray #define COUNTER_DISABLE_EVENTS_IOCTL _IO(0x3E, 0x02) 105b6c50affSWilliam Breathitt Gray 106b6c50affSWilliam Breathitt Gray /** 107b6c50affSWilliam Breathitt Gray * struct counter_event - Counter event data 108b6c50affSWilliam Breathitt Gray * @timestamp: best estimate of time of event occurrence, in nanoseconds 109b6c50affSWilliam Breathitt Gray * @value: component value 110b6c50affSWilliam Breathitt Gray * @watch: component watch configuration 111b6c50affSWilliam Breathitt Gray * @status: return status (system error number) 112b6c50affSWilliam Breathitt Gray */ 113b6c50affSWilliam Breathitt Gray struct counter_event { 114b6c50affSWilliam Breathitt Gray __aligned_u64 timestamp; 115b6c50affSWilliam Breathitt Gray __aligned_u64 value; 116b6c50affSWilliam Breathitt Gray struct counter_watch watch; 117b6c50affSWilliam Breathitt Gray __u8 status; 118b6c50affSWilliam Breathitt Gray }; 119b6c50affSWilliam Breathitt Gray 120e65c26f4SWilliam Breathitt Gray /* Count direction values */ 121e65c26f4SWilliam Breathitt Gray enum counter_count_direction { 122e65c26f4SWilliam Breathitt Gray COUNTER_COUNT_DIRECTION_FORWARD, 123e65c26f4SWilliam Breathitt Gray COUNTER_COUNT_DIRECTION_BACKWARD, 124e65c26f4SWilliam Breathitt Gray }; 125e65c26f4SWilliam Breathitt Gray 126e65c26f4SWilliam Breathitt Gray /* Count mode values */ 127e65c26f4SWilliam Breathitt Gray enum counter_count_mode { 128e65c26f4SWilliam Breathitt Gray COUNTER_COUNT_MODE_NORMAL, 129e65c26f4SWilliam Breathitt Gray COUNTER_COUNT_MODE_RANGE_LIMIT, 130e65c26f4SWilliam Breathitt Gray COUNTER_COUNT_MODE_NON_RECYCLE, 131e65c26f4SWilliam Breathitt Gray COUNTER_COUNT_MODE_MODULO_N, 132d4284874SWilliam Breathitt Gray COUNTER_COUNT_MODE_INTERRUPT_ON_TERMINAL_COUNT, 133d4284874SWilliam Breathitt Gray COUNTER_COUNT_MODE_HARDWARE_RETRIGGERABLE_ONESHOT, 134d4284874SWilliam Breathitt Gray COUNTER_COUNT_MODE_RATE_GENERATOR, 135d4284874SWilliam Breathitt Gray COUNTER_COUNT_MODE_SQUARE_WAVE_MODE, 136d4284874SWilliam Breathitt Gray COUNTER_COUNT_MODE_SOFTWARE_TRIGGERED_STROBE, 137d4284874SWilliam Breathitt Gray COUNTER_COUNT_MODE_HARDWARE_TRIGGERED_STROBE, 138e65c26f4SWilliam Breathitt Gray }; 139e65c26f4SWilliam Breathitt Gray 140e65c26f4SWilliam Breathitt Gray /* Count function values */ 141e65c26f4SWilliam Breathitt Gray enum counter_function { 142e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_INCREASE, 143e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_DECREASE, 144e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_PULSE_DIRECTION, 145e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_QUADRATURE_X1_A, 146e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_QUADRATURE_X1_B, 147e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_QUADRATURE_X2_A, 148e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_QUADRATURE_X2_B, 149e65c26f4SWilliam Breathitt Gray COUNTER_FUNCTION_QUADRATURE_X4, 150e65c26f4SWilliam Breathitt Gray }; 151e65c26f4SWilliam Breathitt Gray 152e65c26f4SWilliam Breathitt Gray /* Signal values */ 153e65c26f4SWilliam Breathitt Gray enum counter_signal_level { 154e65c26f4SWilliam Breathitt Gray COUNTER_SIGNAL_LEVEL_LOW, 155e65c26f4SWilliam Breathitt Gray COUNTER_SIGNAL_LEVEL_HIGH, 156e65c26f4SWilliam Breathitt Gray }; 157e65c26f4SWilliam Breathitt Gray 158e65c26f4SWilliam Breathitt Gray /* Action mode values */ 159e65c26f4SWilliam Breathitt Gray enum counter_synapse_action { 160e65c26f4SWilliam Breathitt Gray COUNTER_SYNAPSE_ACTION_NONE, 161e65c26f4SWilliam Breathitt Gray COUNTER_SYNAPSE_ACTION_RISING_EDGE, 162e65c26f4SWilliam Breathitt Gray COUNTER_SYNAPSE_ACTION_FALLING_EDGE, 163e65c26f4SWilliam Breathitt Gray COUNTER_SYNAPSE_ACTION_BOTH_EDGES, 164e65c26f4SWilliam Breathitt Gray }; 165e65c26f4SWilliam Breathitt Gray 166650ae67bSWilliam Breathitt Gray /* Signal polarity values */ 167650ae67bSWilliam Breathitt Gray enum counter_signal_polarity { 168650ae67bSWilliam Breathitt Gray COUNTER_SIGNAL_POLARITY_POSITIVE, 169650ae67bSWilliam Breathitt Gray COUNTER_SIGNAL_POLARITY_NEGATIVE, 170650ae67bSWilliam Breathitt Gray }; 171650ae67bSWilliam Breathitt Gray 172e65c26f4SWilliam Breathitt Gray #endif /* _UAPI_COUNTER_H_ */ 173