1/* SPDX-License-Identifier: GPL-2.0 */
2
3#ifndef _INDUSTRIAL_IO_OPAQUE_H_
4#define _INDUSTRIAL_IO_OPAQUE_H_
5
6/**
7 * struct iio_dev_opaque - industrial I/O device opaque information
8 * @indio_dev:			public industrial I/O device information
9 * @id:			used to identify device internally
10 * @currentmode:		operating mode currently in use, may be eventually
11 *				checked by device drivers but should be considered
12 *				read-only as this is a core internal bit
13 * @driver_module:		used to make it harder to undercut users
14 * @mlock:			lock used to prevent simultaneous device state changes
15 * @mlock_key:			lockdep class for iio_dev lock
16 * @info_exist_lock:		lock to prevent use during removal
17 * @trig_readonly:		mark the current trigger immutable
18 * @event_interface:		event chrdevs associated with interrupt lines
19 * @attached_buffers:		array of buffers statically attached by the driver
20 * @attached_buffers_cnt:	number of buffers in the array of statically attached buffers
21 * @buffer_ioctl_handler:	ioctl() handler for this IIO device's buffer interface
22 * @buffer_list:		list of all buffers currently attached
23 * @channel_attr_list:		keep track of automatically created channel
24 *				attributes
25 * @chan_attr_group:		group for all attrs in base directory
26 * @ioctl_handlers:		ioctl handlers registered with the core handler
27 * @groups:			attribute groups
28 * @groupcounter:		index of next attribute group
29 * @legacy_scan_el_group:	attribute group for legacy scan elements attribute group
30 * @legacy_buffer_group:	attribute group for legacy buffer attributes group
31 * @bounce_buffer:		for devices that call iio_push_to_buffers_with_timestamp_unaligned()
32 * @bounce_buffer_size:		size of currently allocate bounce buffer
33 * @scan_index_timestamp:	cache of the index to the timestamp
34 * @clock_id:			timestamping clock posix identifier
35 * @chrdev:			associated character device
36 * @flags:			file ops related flags including busy flag.
37 * @debugfs_dentry:		device specific debugfs dentry
38 * @cached_reg_addr:		cached register address for debugfs reads
39 * @read_buf:			read buffer to be used for the initial reg read
40 * @read_buf_len:		data length in @read_buf
41 */
42struct iio_dev_opaque {
43	struct iio_dev			indio_dev;
44	int				currentmode;
45	int				id;
46	struct module			*driver_module;
47	struct mutex			mlock;
48	struct lock_class_key		mlock_key;
49	struct mutex			info_exist_lock;
50	bool				trig_readonly;
51	struct iio_event_interface	*event_interface;
52	struct iio_buffer		**attached_buffers;
53	unsigned int			attached_buffers_cnt;
54	struct iio_ioctl_handler	*buffer_ioctl_handler;
55	struct list_head		buffer_list;
56	struct list_head		channel_attr_list;
57	struct attribute_group		chan_attr_group;
58	struct list_head		ioctl_handlers;
59	const struct attribute_group	**groups;
60	int				groupcounter;
61	struct attribute_group		legacy_scan_el_group;
62	struct attribute_group		legacy_buffer_group;
63	void				*bounce_buffer;
64	size_t				bounce_buffer_size;
65
66	unsigned int			scan_index_timestamp;
67	clockid_t			clock_id;
68	struct cdev			chrdev;
69	unsigned long			flags;
70
71#if defined(CONFIG_DEBUG_FS)
72	struct dentry			*debugfs_dentry;
73	unsigned			cached_reg_addr;
74	char				read_buf[20];
75	unsigned int			read_buf_len;
76#endif
77};
78
79#define to_iio_dev_opaque(_indio_dev)		\
80	container_of((_indio_dev), struct iio_dev_opaque, indio_dev)
81
82#endif
83