1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/* Copyright (c) 2017-2018, The Linux Foundation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 and
* only version 2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
#ifndef __CAM_SYNC_PRIVATE_H__
#define __CAM_SYNC_PRIVATE_H__
#include <linux/bitmap.h>
#include <linux/videodev2.h>
#include <linux/workqueue.h>
#include <linux/interrupt.h>
#include <linux/debugfs.h>
#include <media/v4l2-fh.h>
#include <media/v4l2-device.h>
#include <media/v4l2-subdev.h>
#include <media/v4l2-event.h>
#include <media/v4l2-ioctl.h>
#ifdef CONFIG_CAM_SYNC_DBG
#define CDBG(fmt, args...) pr_err(fmt, ##args)
#else
#define CDBG(fmt, args...) pr_debug(fmt, ##args)
#endif
#define CAM_SYNC_OBJ_NAME_LEN 64
#define CAM_SYNC_MAX_OBJS 1024
#define CAM_SYNC_MAX_V4L2_EVENTS 50
#define CAM_SYNC_DEBUG_FILENAME "cam_debug"
#define CAM_SYNC_DEBUG_BASEDIR "cam"
#define CAM_SYNC_DEBUG_BUF_SIZE 32
#define CAM_SYNC_PAYLOAD_WORDS 2
#define CAM_SYNC_NAME "cam_sync"
#define CAM_SYNC_WORKQUEUE_NAME "HIPRIO_SYNC_WORK_QUEUE"
#define CAM_SYNC_TYPE_INDV 0
#define CAM_SYNC_TYPE_GROUP 1
/**
* enum sync_type - Enum to indicate the type of sync object,
* i.e. individual or group.
*
* @SYNC_TYPE_INDV : Object is an individual sync object
* @SYNC_TYPE_GROUP : Object is a group sync object
*/
enum sync_type {
SYNC_TYPE_INDV,
SYNC_TYPE_GROUP
};
/**
* enum sync_list_clean_type - Enum to indicate the type of list clean action
* to be peformed, i.e. specific sync ID or all list sync ids.
*
* @SYNC_CLEAN_ONE : Specific object to be cleaned in the list
* @SYNC_CLEAN_ALL : Clean all objects in the list
*/
enum sync_list_clean_type {
SYNC_LIST_CLEAN_ONE,
SYNC_LIST_CLEAN_ALL
};
/**
* struct sync_parent_info - Single node of information about a parent
* of a sync object, usually part of the parents linked list
*
* @sync_id : Sync object id of parent
* @list : List member used to append this node to a linked list
*/
struct sync_parent_info {
int32_t sync_id;
struct list_head list;
};
/**
* struct sync_parent_info - Single node of information about a child
* of a sync object, usually part of the children linked list
*
* @sync_id : Sync object id of child
* @list : List member used to append this node to a linked list
*/
struct sync_child_info {
int32_t sync_id;
struct list_head list;
};
/**
* struct sync_callback_info - Single node of information about a kernel
* callback registered on a sync object
*
* @callback_func : Callback function, registered by client driver
* @cb_data : Callback data, registered by client driver
* @status........ : Status with which callback will be invoked in client
* @sync_obj : Sync id of the object for which callback is registered
* @cb_dispatch_work : Work representing the call dispatch
* @list : List member used to append this node to a linked list
*/
struct sync_callback_info {
sync_callback callback_func;
void *cb_data;
int status;
int32_t sync_obj;
struct work_struct cb_dispatch_work;
struct list_head list;
};
/**
* struct sync_user_payload - Single node of information about a user space
* payload registered from user space
*
* @payload_data : Payload data, opaque to kernel
* @list : List member used to append this node to a linked list
*/
struct sync_user_payload {
uint64_t payload_data[CAM_SYNC_PAYLOAD_WORDS];
struct list_head list;
};
/**
* struct sync_table_row - Single row of information about a sync object, used
* for internal book keeping in the sync driver
*
* @name : Optional string representation of the sync object
* @type : Type of the sync object (individual or group)
* @sync_id : Integer id representing this sync object
* @parents_list : Linked list of parents of this sync object
* @children_list : Linked list of children of this sync object
* @state : State (INVALID, ACTIVE, SIGNALED_SUCCESS or
* SIGNALED_ERROR)
* @remaining : Count of remaining children that not been signaled
* @signaled : Completion variable on which block calls will wait
* @callback_list : Linked list of kernel callbacks registered
* @user_payload_list : LInked list of user space payloads registered
*/
struct sync_table_row {
char name[CAM_SYNC_OBJ_NAME_LEN];
enum sync_type type;
int32_t sync_id;
/* List of parents, which are merged objects */
struct list_head parents_list;
/* List of children, which constitute the merged object */
struct list_head children_list;
uint32_t state;
uint32_t remaining;
struct completion signaled;
struct list_head callback_list;
struct list_head user_payload_list;
};
/**
* struct cam_signalable_info - Information for a single sync object that is
* ready to be signaled
*
* @sync_obj : Sync object id of signalable object
* @status : Status with which to signal
* @list : List member used to append this node to a linked list
*/
struct cam_signalable_info {
int32_t sync_obj;
uint32_t status;
struct list_head list;
};
/**
* struct sync_device - Internal struct to book keep sync driver details
*
* @vdev : Video device
* @v4l2_dev : V4L2 device
* @sync_table : Table of all sync objects
* @row_spinlocks : Spinlock array, one for each row in the table
* @table_lock : Mutex used to lock the table
* @open_cnt : Count of file open calls made on the sync driver
* @dentry : Debugfs entry
* @work_queue : Work queue used for dispatching kernel callbacks
* @cam_sync_eventq : Event queue used to dispatch user payloads to user space
* @bitmap : Bitmap representation of all sync objects
*/
struct sync_device {
struct video_device *vdev;
struct v4l2_device v4l2_dev;
struct sync_table_row sync_table[CAM_SYNC_MAX_OBJS];
spinlock_t row_spinlocks[CAM_SYNC_MAX_OBJS];
struct mutex table_lock;
int open_cnt;
struct dentry *dentry;
struct workqueue_struct *work_queue;
struct v4l2_fh *cam_sync_eventq;
spinlock_t cam_sync_eventq_lock;
DECLARE_BITMAP(bitmap, CAM_SYNC_MAX_OBJS);
};
#endif /* __CAM_SYNC_PRIVATE_H__ */
|
