xref: /openbmc/linux/drivers/platform/surface/surface_aggregator_cdev.c (revision 9a87ffc99ec8eb8d35eed7c4f816d75f5cc9662e)
1178f6ab7SMaximilian Luz // SPDX-License-Identifier: GPL-2.0+
2178f6ab7SMaximilian Luz /*
3178f6ab7SMaximilian Luz  * Provides user-space access to the SSAM EC via the /dev/surface/aggregator
4178f6ab7SMaximilian Luz  * misc device. Intended for debugging and development.
5178f6ab7SMaximilian Luz  *
6221756e6SMaximilian Luz  * Copyright (C) 2020-2022 Maximilian Luz <luzmaximilian@gmail.com>
7178f6ab7SMaximilian Luz  */
8178f6ab7SMaximilian Luz 
9178f6ab7SMaximilian Luz #include <linux/fs.h>
10776c53c6SMaximilian Luz #include <linux/ioctl.h>
11178f6ab7SMaximilian Luz #include <linux/kernel.h>
12776c53c6SMaximilian Luz #include <linux/kfifo.h>
13178f6ab7SMaximilian Luz #include <linux/kref.h>
14178f6ab7SMaximilian Luz #include <linux/miscdevice.h>
15178f6ab7SMaximilian Luz #include <linux/module.h>
16178f6ab7SMaximilian Luz #include <linux/platform_device.h>
17776c53c6SMaximilian Luz #include <linux/poll.h>
18178f6ab7SMaximilian Luz #include <linux/rwsem.h>
19178f6ab7SMaximilian Luz #include <linux/slab.h>
20178f6ab7SMaximilian Luz #include <linux/uaccess.h>
21776c53c6SMaximilian Luz #include <linux/vmalloc.h>
22178f6ab7SMaximilian Luz 
23178f6ab7SMaximilian Luz #include <linux/surface_aggregator/cdev.h>
24178f6ab7SMaximilian Luz #include <linux/surface_aggregator/controller.h>
25776c53c6SMaximilian Luz #include <linux/surface_aggregator/serial_hub.h>
26178f6ab7SMaximilian Luz 
27178f6ab7SMaximilian Luz #define SSAM_CDEV_DEVICE_NAME	"surface_aggregator_cdev"
28178f6ab7SMaximilian Luz 
29776c53c6SMaximilian Luz 
30776c53c6SMaximilian Luz /* -- Main structures. ------------------------------------------------------ */
31776c53c6SMaximilian Luz 
32776c53c6SMaximilian Luz enum ssam_cdev_device_state {
33776c53c6SMaximilian Luz 	SSAM_CDEV_DEVICE_SHUTDOWN_BIT = BIT(0),
34776c53c6SMaximilian Luz };
35776c53c6SMaximilian Luz 
36178f6ab7SMaximilian Luz struct ssam_cdev {
37178f6ab7SMaximilian Luz 	struct kref kref;
38178f6ab7SMaximilian Luz 	struct rw_semaphore lock;
39776c53c6SMaximilian Luz 
40776c53c6SMaximilian Luz 	struct device *dev;
41178f6ab7SMaximilian Luz 	struct ssam_controller *ctrl;
42178f6ab7SMaximilian Luz 	struct miscdevice mdev;
43776c53c6SMaximilian Luz 	unsigned long flags;
44776c53c6SMaximilian Luz 
45776c53c6SMaximilian Luz 	struct rw_semaphore client_lock;  /* Guards client list. */
46776c53c6SMaximilian Luz 	struct list_head client_list;
47776c53c6SMaximilian Luz };
48776c53c6SMaximilian Luz 
49776c53c6SMaximilian Luz struct ssam_cdev_client;
50776c53c6SMaximilian Luz 
51776c53c6SMaximilian Luz struct ssam_cdev_notifier {
52776c53c6SMaximilian Luz 	struct ssam_cdev_client *client;
53776c53c6SMaximilian Luz 	struct ssam_event_notifier nf;
54776c53c6SMaximilian Luz };
55776c53c6SMaximilian Luz 
56776c53c6SMaximilian Luz struct ssam_cdev_client {
57776c53c6SMaximilian Luz 	struct ssam_cdev *cdev;
58776c53c6SMaximilian Luz 	struct list_head node;
59776c53c6SMaximilian Luz 
60776c53c6SMaximilian Luz 	struct mutex notifier_lock;	/* Guards notifier access for registration */
61776c53c6SMaximilian Luz 	struct ssam_cdev_notifier *notifier[SSH_NUM_EVENTS];
62776c53c6SMaximilian Luz 
63776c53c6SMaximilian Luz 	struct mutex read_lock;		/* Guards FIFO buffer read access */
64776c53c6SMaximilian Luz 	struct mutex write_lock;	/* Guards FIFO buffer write access */
65776c53c6SMaximilian Luz 	DECLARE_KFIFO(buffer, u8, 4096);
66776c53c6SMaximilian Luz 
67776c53c6SMaximilian Luz 	wait_queue_head_t waitq;
68776c53c6SMaximilian Luz 	struct fasync_struct *fasync;
69178f6ab7SMaximilian Luz };
70178f6ab7SMaximilian Luz 
__ssam_cdev_release(struct kref * kref)71178f6ab7SMaximilian Luz static void __ssam_cdev_release(struct kref *kref)
72178f6ab7SMaximilian Luz {
73178f6ab7SMaximilian Luz 	kfree(container_of(kref, struct ssam_cdev, kref));
74178f6ab7SMaximilian Luz }
75178f6ab7SMaximilian Luz 
ssam_cdev_get(struct ssam_cdev * cdev)76178f6ab7SMaximilian Luz static struct ssam_cdev *ssam_cdev_get(struct ssam_cdev *cdev)
77178f6ab7SMaximilian Luz {
78178f6ab7SMaximilian Luz 	if (cdev)
79178f6ab7SMaximilian Luz 		kref_get(&cdev->kref);
80178f6ab7SMaximilian Luz 
81178f6ab7SMaximilian Luz 	return cdev;
82178f6ab7SMaximilian Luz }
83178f6ab7SMaximilian Luz 
ssam_cdev_put(struct ssam_cdev * cdev)84178f6ab7SMaximilian Luz static void ssam_cdev_put(struct ssam_cdev *cdev)
85178f6ab7SMaximilian Luz {
86178f6ab7SMaximilian Luz 	if (cdev)
87178f6ab7SMaximilian Luz 		kref_put(&cdev->kref, __ssam_cdev_release);
88178f6ab7SMaximilian Luz }
89178f6ab7SMaximilian Luz 
90178f6ab7SMaximilian Luz 
91776c53c6SMaximilian Luz /* -- Notifier handling. ---------------------------------------------------- */
92178f6ab7SMaximilian Luz 
ssam_cdev_notifier(struct ssam_event_notifier * nf,const struct ssam_event * in)93776c53c6SMaximilian Luz static u32 ssam_cdev_notifier(struct ssam_event_notifier *nf, const struct ssam_event *in)
94178f6ab7SMaximilian Luz {
95776c53c6SMaximilian Luz 	struct ssam_cdev_notifier *cdev_nf = container_of(nf, struct ssam_cdev_notifier, nf);
96776c53c6SMaximilian Luz 	struct ssam_cdev_client *client = cdev_nf->client;
97776c53c6SMaximilian Luz 	struct ssam_cdev_event event;
98776c53c6SMaximilian Luz 	size_t n = struct_size(&event, data, in->length);
99776c53c6SMaximilian Luz 
100776c53c6SMaximilian Luz 	/* Translate event. */
101776c53c6SMaximilian Luz 	event.target_category = in->target_category;
102776c53c6SMaximilian Luz 	event.target_id = in->target_id;
103776c53c6SMaximilian Luz 	event.command_id = in->command_id;
104776c53c6SMaximilian Luz 	event.instance_id = in->instance_id;
105776c53c6SMaximilian Luz 	event.length = in->length;
106776c53c6SMaximilian Luz 
107776c53c6SMaximilian Luz 	mutex_lock(&client->write_lock);
108776c53c6SMaximilian Luz 
109776c53c6SMaximilian Luz 	/* Make sure we have enough space. */
110776c53c6SMaximilian Luz 	if (kfifo_avail(&client->buffer) < n) {
111776c53c6SMaximilian Luz 		dev_warn(client->cdev->dev,
112776c53c6SMaximilian Luz 			 "buffer full, dropping event (tc: %#04x, tid: %#04x, cid: %#04x, iid: %#04x)\n",
113776c53c6SMaximilian Luz 			 in->target_category, in->target_id, in->command_id, in->instance_id);
114776c53c6SMaximilian Luz 		mutex_unlock(&client->write_lock);
115178f6ab7SMaximilian Luz 		return 0;
116178f6ab7SMaximilian Luz 	}
117178f6ab7SMaximilian Luz 
118776c53c6SMaximilian Luz 	/* Copy event header and payload. */
119776c53c6SMaximilian Luz 	kfifo_in(&client->buffer, (const u8 *)&event, struct_size(&event, data, 0));
120776c53c6SMaximilian Luz 	kfifo_in(&client->buffer, &in->data[0], in->length);
121776c53c6SMaximilian Luz 
122776c53c6SMaximilian Luz 	mutex_unlock(&client->write_lock);
123776c53c6SMaximilian Luz 
124776c53c6SMaximilian Luz 	/* Notify waiting readers. */
125776c53c6SMaximilian Luz 	kill_fasync(&client->fasync, SIGIO, POLL_IN);
126776c53c6SMaximilian Luz 	wake_up_interruptible(&client->waitq);
127776c53c6SMaximilian Luz 
128776c53c6SMaximilian Luz 	/*
129776c53c6SMaximilian Luz 	 * Don't mark events as handled, this is the job of a proper driver and
130776c53c6SMaximilian Luz 	 * not the debugging interface.
131776c53c6SMaximilian Luz 	 */
132776c53c6SMaximilian Luz 	return 0;
133776c53c6SMaximilian Luz }
134776c53c6SMaximilian Luz 
ssam_cdev_notifier_register(struct ssam_cdev_client * client,u8 tc,int priority)135776c53c6SMaximilian Luz static int ssam_cdev_notifier_register(struct ssam_cdev_client *client, u8 tc, int priority)
136178f6ab7SMaximilian Luz {
137776c53c6SMaximilian Luz 	const u16 rqid = ssh_tc_to_rqid(tc);
138776c53c6SMaximilian Luz 	const u16 event = ssh_rqid_to_event(rqid);
139776c53c6SMaximilian Luz 	struct ssam_cdev_notifier *nf;
140776c53c6SMaximilian Luz 	int status;
141776c53c6SMaximilian Luz 
142cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
143cbd224e0SMaximilian Luz 
144776c53c6SMaximilian Luz 	/* Validate notifier target category. */
145776c53c6SMaximilian Luz 	if (!ssh_rqid_is_event(rqid))
146776c53c6SMaximilian Luz 		return -EINVAL;
147776c53c6SMaximilian Luz 
148776c53c6SMaximilian Luz 	mutex_lock(&client->notifier_lock);
149776c53c6SMaximilian Luz 
150776c53c6SMaximilian Luz 	/* Check if the notifier has already been registered. */
151776c53c6SMaximilian Luz 	if (client->notifier[event]) {
152776c53c6SMaximilian Luz 		mutex_unlock(&client->notifier_lock);
153776c53c6SMaximilian Luz 		return -EEXIST;
154776c53c6SMaximilian Luz 	}
155776c53c6SMaximilian Luz 
156776c53c6SMaximilian Luz 	/* Allocate new notifier. */
157776c53c6SMaximilian Luz 	nf = kzalloc(sizeof(*nf), GFP_KERNEL);
158776c53c6SMaximilian Luz 	if (!nf) {
159776c53c6SMaximilian Luz 		mutex_unlock(&client->notifier_lock);
160776c53c6SMaximilian Luz 		return -ENOMEM;
161776c53c6SMaximilian Luz 	}
162776c53c6SMaximilian Luz 
163776c53c6SMaximilian Luz 	/*
164776c53c6SMaximilian Luz 	 * Create a dummy notifier with the minimal required fields for
165776c53c6SMaximilian Luz 	 * observer registration. Note that we can skip fully specifying event
166776c53c6SMaximilian Luz 	 * and registry here as we do not need any matching and use silent
167776c53c6SMaximilian Luz 	 * registration, which does not enable the corresponding event.
168776c53c6SMaximilian Luz 	 */
169776c53c6SMaximilian Luz 	nf->client = client;
170776c53c6SMaximilian Luz 	nf->nf.base.fn = ssam_cdev_notifier;
171776c53c6SMaximilian Luz 	nf->nf.base.priority = priority;
172776c53c6SMaximilian Luz 	nf->nf.event.id.target_category = tc;
173776c53c6SMaximilian Luz 	nf->nf.event.mask = 0;	/* Do not do any matching. */
174776c53c6SMaximilian Luz 	nf->nf.flags = SSAM_EVENT_NOTIFIER_OBSERVER;
175776c53c6SMaximilian Luz 
176776c53c6SMaximilian Luz 	/* Register notifier. */
177776c53c6SMaximilian Luz 	status = ssam_notifier_register(client->cdev->ctrl, &nf->nf);
178776c53c6SMaximilian Luz 	if (status)
179776c53c6SMaximilian Luz 		kfree(nf);
180776c53c6SMaximilian Luz 	else
181776c53c6SMaximilian Luz 		client->notifier[event] = nf;
182776c53c6SMaximilian Luz 
183776c53c6SMaximilian Luz 	mutex_unlock(&client->notifier_lock);
184776c53c6SMaximilian Luz 	return status;
185776c53c6SMaximilian Luz }
186776c53c6SMaximilian Luz 
ssam_cdev_notifier_unregister(struct ssam_cdev_client * client,u8 tc)187776c53c6SMaximilian Luz static int ssam_cdev_notifier_unregister(struct ssam_cdev_client *client, u8 tc)
188776c53c6SMaximilian Luz {
189776c53c6SMaximilian Luz 	const u16 rqid = ssh_tc_to_rqid(tc);
190776c53c6SMaximilian Luz 	const u16 event = ssh_rqid_to_event(rqid);
191776c53c6SMaximilian Luz 	int status;
192776c53c6SMaximilian Luz 
193cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
194cbd224e0SMaximilian Luz 
195776c53c6SMaximilian Luz 	/* Validate notifier target category. */
196776c53c6SMaximilian Luz 	if (!ssh_rqid_is_event(rqid))
197776c53c6SMaximilian Luz 		return -EINVAL;
198776c53c6SMaximilian Luz 
199776c53c6SMaximilian Luz 	mutex_lock(&client->notifier_lock);
200776c53c6SMaximilian Luz 
201776c53c6SMaximilian Luz 	/* Check if the notifier is currently registered. */
202776c53c6SMaximilian Luz 	if (!client->notifier[event]) {
203776c53c6SMaximilian Luz 		mutex_unlock(&client->notifier_lock);
204776c53c6SMaximilian Luz 		return -ENOENT;
205776c53c6SMaximilian Luz 	}
206776c53c6SMaximilian Luz 
207776c53c6SMaximilian Luz 	/* Unregister and free notifier. */
208776c53c6SMaximilian Luz 	status = ssam_notifier_unregister(client->cdev->ctrl, &client->notifier[event]->nf);
209776c53c6SMaximilian Luz 	kfree(client->notifier[event]);
210776c53c6SMaximilian Luz 	client->notifier[event] = NULL;
211776c53c6SMaximilian Luz 
212776c53c6SMaximilian Luz 	mutex_unlock(&client->notifier_lock);
213776c53c6SMaximilian Luz 	return status;
214776c53c6SMaximilian Luz }
215776c53c6SMaximilian Luz 
ssam_cdev_notifier_unregister_all(struct ssam_cdev_client * client)216776c53c6SMaximilian Luz static void ssam_cdev_notifier_unregister_all(struct ssam_cdev_client *client)
217776c53c6SMaximilian Luz {
218776c53c6SMaximilian Luz 	int i;
219776c53c6SMaximilian Luz 
220776c53c6SMaximilian Luz 	down_read(&client->cdev->lock);
221776c53c6SMaximilian Luz 
222776c53c6SMaximilian Luz 	/*
223776c53c6SMaximilian Luz 	 * This function may be used during shutdown, thus we need to test for
224776c53c6SMaximilian Luz 	 * cdev->ctrl instead of the SSAM_CDEV_DEVICE_SHUTDOWN_BIT bit.
225776c53c6SMaximilian Luz 	 */
226776c53c6SMaximilian Luz 	if (client->cdev->ctrl) {
227776c53c6SMaximilian Luz 		for (i = 0; i < SSH_NUM_EVENTS; i++)
228776c53c6SMaximilian Luz 			ssam_cdev_notifier_unregister(client, i + 1);
229776c53c6SMaximilian Luz 
230776c53c6SMaximilian Luz 	} else {
231776c53c6SMaximilian Luz 		int count = 0;
232776c53c6SMaximilian Luz 
233776c53c6SMaximilian Luz 		/*
234776c53c6SMaximilian Luz 		 * Device has been shut down. Any notifier remaining is a bug,
235776c53c6SMaximilian Luz 		 * so warn about that as this would otherwise hardly be
236776c53c6SMaximilian Luz 		 * noticeable. Nevertheless, free them as well.
237776c53c6SMaximilian Luz 		 */
238776c53c6SMaximilian Luz 		mutex_lock(&client->notifier_lock);
239776c53c6SMaximilian Luz 		for (i = 0; i < SSH_NUM_EVENTS; i++) {
240776c53c6SMaximilian Luz 			count += !!(client->notifier[i]);
241776c53c6SMaximilian Luz 			kfree(client->notifier[i]);
242776c53c6SMaximilian Luz 			client->notifier[i] = NULL;
243776c53c6SMaximilian Luz 		}
244776c53c6SMaximilian Luz 		mutex_unlock(&client->notifier_lock);
245776c53c6SMaximilian Luz 
246776c53c6SMaximilian Luz 		WARN_ON(count > 0);
247776c53c6SMaximilian Luz 	}
248776c53c6SMaximilian Luz 
249776c53c6SMaximilian Luz 	up_read(&client->cdev->lock);
250776c53c6SMaximilian Luz }
251776c53c6SMaximilian Luz 
252776c53c6SMaximilian Luz 
253776c53c6SMaximilian Luz /* -- IOCTL functions. ------------------------------------------------------ */
254776c53c6SMaximilian Luz 
ssam_cdev_request(struct ssam_cdev_client * client,struct ssam_cdev_request __user * r)255776c53c6SMaximilian Luz static long ssam_cdev_request(struct ssam_cdev_client *client, struct ssam_cdev_request __user *r)
256776c53c6SMaximilian Luz {
257178f6ab7SMaximilian Luz 	struct ssam_cdev_request rqst;
258a403c1dfSMaximilian Luz 	struct ssam_request spec = {};
259a403c1dfSMaximilian Luz 	struct ssam_response rsp = {};
260178f6ab7SMaximilian Luz 	const void __user *plddata;
261178f6ab7SMaximilian Luz 	void __user *rspdata;
262178f6ab7SMaximilian Luz 	int status = 0, ret = 0, tmp;
263178f6ab7SMaximilian Luz 
264cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
265cbd224e0SMaximilian Luz 
266178f6ab7SMaximilian Luz 	ret = copy_struct_from_user(&rqst, sizeof(rqst), r, sizeof(*r));
267178f6ab7SMaximilian Luz 	if (ret)
268178f6ab7SMaximilian Luz 		goto out;
269178f6ab7SMaximilian Luz 
270178f6ab7SMaximilian Luz 	plddata = u64_to_user_ptr(rqst.payload.data);
271178f6ab7SMaximilian Luz 	rspdata = u64_to_user_ptr(rqst.response.data);
272178f6ab7SMaximilian Luz 
273178f6ab7SMaximilian Luz 	/* Setup basic request fields. */
274178f6ab7SMaximilian Luz 	spec.target_category = rqst.target_category;
275178f6ab7SMaximilian Luz 	spec.target_id = rqst.target_id;
276178f6ab7SMaximilian Luz 	spec.command_id = rqst.command_id;
277178f6ab7SMaximilian Luz 	spec.instance_id = rqst.instance_id;
278178f6ab7SMaximilian Luz 	spec.flags = 0;
279178f6ab7SMaximilian Luz 	spec.length = rqst.payload.length;
280178f6ab7SMaximilian Luz 	spec.payload = NULL;
281178f6ab7SMaximilian Luz 
282178f6ab7SMaximilian Luz 	if (rqst.flags & SSAM_CDEV_REQUEST_HAS_RESPONSE)
283178f6ab7SMaximilian Luz 		spec.flags |= SSAM_REQUEST_HAS_RESPONSE;
284178f6ab7SMaximilian Luz 
285178f6ab7SMaximilian Luz 	if (rqst.flags & SSAM_CDEV_REQUEST_UNSEQUENCED)
286178f6ab7SMaximilian Luz 		spec.flags |= SSAM_REQUEST_UNSEQUENCED;
287178f6ab7SMaximilian Luz 
288178f6ab7SMaximilian Luz 	rsp.capacity = rqst.response.length;
289178f6ab7SMaximilian Luz 	rsp.length = 0;
290178f6ab7SMaximilian Luz 	rsp.pointer = NULL;
291178f6ab7SMaximilian Luz 
292178f6ab7SMaximilian Luz 	/* Get request payload from user-space. */
293178f6ab7SMaximilian Luz 	if (spec.length) {
294178f6ab7SMaximilian Luz 		if (!plddata) {
295178f6ab7SMaximilian Luz 			ret = -EINVAL;
296178f6ab7SMaximilian Luz 			goto out;
297178f6ab7SMaximilian Luz 		}
298178f6ab7SMaximilian Luz 
299e94a2650SMaximilian Luz 		/*
300e94a2650SMaximilian Luz 		 * Note: spec.length is limited to U16_MAX bytes via struct
301e94a2650SMaximilian Luz 		 * ssam_cdev_request. This is slightly larger than the
302e94a2650SMaximilian Luz 		 * theoretical maximum (SSH_COMMAND_MAX_PAYLOAD_SIZE) of the
303e94a2650SMaximilian Luz 		 * underlying protocol (note that nothing remotely this size
304e94a2650SMaximilian Luz 		 * should ever be allocated in any normal case). This size is
305*b09ee1cdSMaximilian Luz 		 * validated later in ssam_request_do_sync(), for allocation
306*b09ee1cdSMaximilian Luz 		 * the bound imposed by u16 should be enough.
307e94a2650SMaximilian Luz 		 */
308178f6ab7SMaximilian Luz 		spec.payload = kzalloc(spec.length, GFP_KERNEL);
309178f6ab7SMaximilian Luz 		if (!spec.payload) {
310178f6ab7SMaximilian Luz 			ret = -ENOMEM;
311178f6ab7SMaximilian Luz 			goto out;
312178f6ab7SMaximilian Luz 		}
313178f6ab7SMaximilian Luz 
314178f6ab7SMaximilian Luz 		if (copy_from_user((void *)spec.payload, plddata, spec.length)) {
315178f6ab7SMaximilian Luz 			ret = -EFAULT;
316178f6ab7SMaximilian Luz 			goto out;
317178f6ab7SMaximilian Luz 		}
318178f6ab7SMaximilian Luz 	}
319178f6ab7SMaximilian Luz 
320178f6ab7SMaximilian Luz 	/* Allocate response buffer. */
321178f6ab7SMaximilian Luz 	if (rsp.capacity) {
322178f6ab7SMaximilian Luz 		if (!rspdata) {
323178f6ab7SMaximilian Luz 			ret = -EINVAL;
324178f6ab7SMaximilian Luz 			goto out;
325178f6ab7SMaximilian Luz 		}
326178f6ab7SMaximilian Luz 
327e94a2650SMaximilian Luz 		/*
328e94a2650SMaximilian Luz 		 * Note: rsp.capacity is limited to U16_MAX bytes via struct
329e94a2650SMaximilian Luz 		 * ssam_cdev_request. This is slightly larger than the
330e94a2650SMaximilian Luz 		 * theoretical maximum (SSH_COMMAND_MAX_PAYLOAD_SIZE) of the
331e94a2650SMaximilian Luz 		 * underlying protocol (note that nothing remotely this size
332e94a2650SMaximilian Luz 		 * should ever be allocated in any normal case). In later use,
333e94a2650SMaximilian Luz 		 * this capacity does not have to be strictly bounded, as it
334e94a2650SMaximilian Luz 		 * is only used as an output buffer to be written to. For
335e94a2650SMaximilian Luz 		 * allocation the bound imposed by u16 should be enough.
336e94a2650SMaximilian Luz 		 */
337178f6ab7SMaximilian Luz 		rsp.pointer = kzalloc(rsp.capacity, GFP_KERNEL);
338178f6ab7SMaximilian Luz 		if (!rsp.pointer) {
339178f6ab7SMaximilian Luz 			ret = -ENOMEM;
340178f6ab7SMaximilian Luz 			goto out;
341178f6ab7SMaximilian Luz 		}
342178f6ab7SMaximilian Luz 	}
343178f6ab7SMaximilian Luz 
344178f6ab7SMaximilian Luz 	/* Perform request. */
345*b09ee1cdSMaximilian Luz 	status = ssam_request_do_sync(client->cdev->ctrl, &spec, &rsp);
346178f6ab7SMaximilian Luz 	if (status)
347178f6ab7SMaximilian Luz 		goto out;
348178f6ab7SMaximilian Luz 
349178f6ab7SMaximilian Luz 	/* Copy response to user-space. */
350178f6ab7SMaximilian Luz 	if (rsp.length && copy_to_user(rspdata, rsp.pointer, rsp.length))
351178f6ab7SMaximilian Luz 		ret = -EFAULT;
352178f6ab7SMaximilian Luz 
353178f6ab7SMaximilian Luz out:
354178f6ab7SMaximilian Luz 	/* Always try to set response-length and status. */
355178f6ab7SMaximilian Luz 	tmp = put_user(rsp.length, &r->response.length);
356178f6ab7SMaximilian Luz 	if (tmp)
357178f6ab7SMaximilian Luz 		ret = tmp;
358178f6ab7SMaximilian Luz 
359178f6ab7SMaximilian Luz 	tmp = put_user(status, &r->status);
360178f6ab7SMaximilian Luz 	if (tmp)
361178f6ab7SMaximilian Luz 		ret = tmp;
362178f6ab7SMaximilian Luz 
363178f6ab7SMaximilian Luz 	/* Cleanup. */
364178f6ab7SMaximilian Luz 	kfree(spec.payload);
365178f6ab7SMaximilian Luz 	kfree(rsp.pointer);
366178f6ab7SMaximilian Luz 
367178f6ab7SMaximilian Luz 	return ret;
368178f6ab7SMaximilian Luz }
369178f6ab7SMaximilian Luz 
ssam_cdev_notif_register(struct ssam_cdev_client * client,const struct ssam_cdev_notifier_desc __user * d)370776c53c6SMaximilian Luz static long ssam_cdev_notif_register(struct ssam_cdev_client *client,
371776c53c6SMaximilian Luz 				     const struct ssam_cdev_notifier_desc __user *d)
372776c53c6SMaximilian Luz {
373776c53c6SMaximilian Luz 	struct ssam_cdev_notifier_desc desc;
374776c53c6SMaximilian Luz 	long ret;
375776c53c6SMaximilian Luz 
376cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
377cbd224e0SMaximilian Luz 
378776c53c6SMaximilian Luz 	ret = copy_struct_from_user(&desc, sizeof(desc), d, sizeof(*d));
379776c53c6SMaximilian Luz 	if (ret)
380776c53c6SMaximilian Luz 		return ret;
381776c53c6SMaximilian Luz 
382776c53c6SMaximilian Luz 	return ssam_cdev_notifier_register(client, desc.target_category, desc.priority);
383776c53c6SMaximilian Luz }
384776c53c6SMaximilian Luz 
ssam_cdev_notif_unregister(struct ssam_cdev_client * client,const struct ssam_cdev_notifier_desc __user * d)385776c53c6SMaximilian Luz static long ssam_cdev_notif_unregister(struct ssam_cdev_client *client,
386776c53c6SMaximilian Luz 				       const struct ssam_cdev_notifier_desc __user *d)
387776c53c6SMaximilian Luz {
388776c53c6SMaximilian Luz 	struct ssam_cdev_notifier_desc desc;
389776c53c6SMaximilian Luz 	long ret;
390776c53c6SMaximilian Luz 
391cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
392cbd224e0SMaximilian Luz 
393776c53c6SMaximilian Luz 	ret = copy_struct_from_user(&desc, sizeof(desc), d, sizeof(*d));
394776c53c6SMaximilian Luz 	if (ret)
395776c53c6SMaximilian Luz 		return ret;
396776c53c6SMaximilian Luz 
397776c53c6SMaximilian Luz 	return ssam_cdev_notifier_unregister(client, desc.target_category);
398776c53c6SMaximilian Luz }
399776c53c6SMaximilian Luz 
ssam_cdev_event_enable(struct ssam_cdev_client * client,const struct ssam_cdev_event_desc __user * d)400e8e298a6SMaximilian Luz static long ssam_cdev_event_enable(struct ssam_cdev_client *client,
401e8e298a6SMaximilian Luz 				   const struct ssam_cdev_event_desc __user *d)
402e8e298a6SMaximilian Luz {
403e8e298a6SMaximilian Luz 	struct ssam_cdev_event_desc desc;
404e8e298a6SMaximilian Luz 	struct ssam_event_registry reg;
405e8e298a6SMaximilian Luz 	struct ssam_event_id id;
406e8e298a6SMaximilian Luz 	long ret;
407e8e298a6SMaximilian Luz 
408cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
409cbd224e0SMaximilian Luz 
410e8e298a6SMaximilian Luz 	/* Read descriptor from user-space. */
411e8e298a6SMaximilian Luz 	ret = copy_struct_from_user(&desc, sizeof(desc), d, sizeof(*d));
412e8e298a6SMaximilian Luz 	if (ret)
413e8e298a6SMaximilian Luz 		return ret;
414e8e298a6SMaximilian Luz 
415e8e298a6SMaximilian Luz 	/* Translate descriptor. */
416e8e298a6SMaximilian Luz 	reg.target_category = desc.reg.target_category;
417e8e298a6SMaximilian Luz 	reg.target_id = desc.reg.target_id;
418e8e298a6SMaximilian Luz 	reg.cid_enable = desc.reg.cid_enable;
419e8e298a6SMaximilian Luz 	reg.cid_disable = desc.reg.cid_disable;
420e8e298a6SMaximilian Luz 
421e8e298a6SMaximilian Luz 	id.target_category = desc.id.target_category;
422e8e298a6SMaximilian Luz 	id.instance = desc.id.instance;
423e8e298a6SMaximilian Luz 
424e8e298a6SMaximilian Luz 	/* Disable event. */
425e8e298a6SMaximilian Luz 	return ssam_controller_event_enable(client->cdev->ctrl, reg, id, desc.flags);
426e8e298a6SMaximilian Luz }
427e8e298a6SMaximilian Luz 
ssam_cdev_event_disable(struct ssam_cdev_client * client,const struct ssam_cdev_event_desc __user * d)428e8e298a6SMaximilian Luz static long ssam_cdev_event_disable(struct ssam_cdev_client *client,
429e8e298a6SMaximilian Luz 				    const struct ssam_cdev_event_desc __user *d)
430e8e298a6SMaximilian Luz {
431e8e298a6SMaximilian Luz 	struct ssam_cdev_event_desc desc;
432e8e298a6SMaximilian Luz 	struct ssam_event_registry reg;
433e8e298a6SMaximilian Luz 	struct ssam_event_id id;
434e8e298a6SMaximilian Luz 	long ret;
435e8e298a6SMaximilian Luz 
436cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
437cbd224e0SMaximilian Luz 
438e8e298a6SMaximilian Luz 	/* Read descriptor from user-space. */
439e8e298a6SMaximilian Luz 	ret = copy_struct_from_user(&desc, sizeof(desc), d, sizeof(*d));
440e8e298a6SMaximilian Luz 	if (ret)
441e8e298a6SMaximilian Luz 		return ret;
442e8e298a6SMaximilian Luz 
443e8e298a6SMaximilian Luz 	/* Translate descriptor. */
444e8e298a6SMaximilian Luz 	reg.target_category = desc.reg.target_category;
445e8e298a6SMaximilian Luz 	reg.target_id = desc.reg.target_id;
446e8e298a6SMaximilian Luz 	reg.cid_enable = desc.reg.cid_enable;
447e8e298a6SMaximilian Luz 	reg.cid_disable = desc.reg.cid_disable;
448e8e298a6SMaximilian Luz 
449e8e298a6SMaximilian Luz 	id.target_category = desc.id.target_category;
450e8e298a6SMaximilian Luz 	id.instance = desc.id.instance;
451e8e298a6SMaximilian Luz 
452e8e298a6SMaximilian Luz 	/* Disable event. */
453e8e298a6SMaximilian Luz 	return ssam_controller_event_disable(client->cdev->ctrl, reg, id, desc.flags);
454e8e298a6SMaximilian Luz }
455e8e298a6SMaximilian Luz 
456776c53c6SMaximilian Luz 
457776c53c6SMaximilian Luz /* -- File operations. ------------------------------------------------------ */
458776c53c6SMaximilian Luz 
ssam_cdev_device_open(struct inode * inode,struct file * filp)459776c53c6SMaximilian Luz static int ssam_cdev_device_open(struct inode *inode, struct file *filp)
460776c53c6SMaximilian Luz {
461776c53c6SMaximilian Luz 	struct miscdevice *mdev = filp->private_data;
462776c53c6SMaximilian Luz 	struct ssam_cdev_client *client;
463776c53c6SMaximilian Luz 	struct ssam_cdev *cdev = container_of(mdev, struct ssam_cdev, mdev);
464776c53c6SMaximilian Luz 
465776c53c6SMaximilian Luz 	/* Initialize client */
466776c53c6SMaximilian Luz 	client = vzalloc(sizeof(*client));
467776c53c6SMaximilian Luz 	if (!client)
468776c53c6SMaximilian Luz 		return -ENOMEM;
469776c53c6SMaximilian Luz 
470776c53c6SMaximilian Luz 	client->cdev = ssam_cdev_get(cdev);
471776c53c6SMaximilian Luz 
472776c53c6SMaximilian Luz 	INIT_LIST_HEAD(&client->node);
473776c53c6SMaximilian Luz 
474776c53c6SMaximilian Luz 	mutex_init(&client->notifier_lock);
475776c53c6SMaximilian Luz 
476776c53c6SMaximilian Luz 	mutex_init(&client->read_lock);
477776c53c6SMaximilian Luz 	mutex_init(&client->write_lock);
478776c53c6SMaximilian Luz 	INIT_KFIFO(client->buffer);
479776c53c6SMaximilian Luz 	init_waitqueue_head(&client->waitq);
480776c53c6SMaximilian Luz 
481776c53c6SMaximilian Luz 	filp->private_data = client;
482776c53c6SMaximilian Luz 
483776c53c6SMaximilian Luz 	/* Attach client. */
484776c53c6SMaximilian Luz 	down_write(&cdev->client_lock);
485776c53c6SMaximilian Luz 
486776c53c6SMaximilian Luz 	if (test_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT, &cdev->flags)) {
487776c53c6SMaximilian Luz 		up_write(&cdev->client_lock);
488776c53c6SMaximilian Luz 		mutex_destroy(&client->write_lock);
489776c53c6SMaximilian Luz 		mutex_destroy(&client->read_lock);
490776c53c6SMaximilian Luz 		mutex_destroy(&client->notifier_lock);
491776c53c6SMaximilian Luz 		ssam_cdev_put(client->cdev);
492776c53c6SMaximilian Luz 		vfree(client);
493776c53c6SMaximilian Luz 		return -ENODEV;
494776c53c6SMaximilian Luz 	}
495776c53c6SMaximilian Luz 	list_add_tail(&client->node, &cdev->client_list);
496776c53c6SMaximilian Luz 
497776c53c6SMaximilian Luz 	up_write(&cdev->client_lock);
498776c53c6SMaximilian Luz 
499776c53c6SMaximilian Luz 	stream_open(inode, filp);
500776c53c6SMaximilian Luz 	return 0;
501776c53c6SMaximilian Luz }
502776c53c6SMaximilian Luz 
ssam_cdev_device_release(struct inode * inode,struct file * filp)503776c53c6SMaximilian Luz static int ssam_cdev_device_release(struct inode *inode, struct file *filp)
504776c53c6SMaximilian Luz {
505776c53c6SMaximilian Luz 	struct ssam_cdev_client *client = filp->private_data;
506776c53c6SMaximilian Luz 
507776c53c6SMaximilian Luz 	/* Force-unregister all remaining notifiers of this client. */
508776c53c6SMaximilian Luz 	ssam_cdev_notifier_unregister_all(client);
509776c53c6SMaximilian Luz 
510776c53c6SMaximilian Luz 	/* Detach client. */
511776c53c6SMaximilian Luz 	down_write(&client->cdev->client_lock);
512776c53c6SMaximilian Luz 	list_del(&client->node);
513776c53c6SMaximilian Luz 	up_write(&client->cdev->client_lock);
514776c53c6SMaximilian Luz 
515776c53c6SMaximilian Luz 	/* Free client. */
516776c53c6SMaximilian Luz 	mutex_destroy(&client->write_lock);
517776c53c6SMaximilian Luz 	mutex_destroy(&client->read_lock);
518776c53c6SMaximilian Luz 
519776c53c6SMaximilian Luz 	mutex_destroy(&client->notifier_lock);
520776c53c6SMaximilian Luz 
521776c53c6SMaximilian Luz 	ssam_cdev_put(client->cdev);
522776c53c6SMaximilian Luz 	vfree(client);
523776c53c6SMaximilian Luz 
524776c53c6SMaximilian Luz 	return 0;
525776c53c6SMaximilian Luz }
526776c53c6SMaximilian Luz 
__ssam_cdev_device_ioctl(struct ssam_cdev_client * client,unsigned int cmd,unsigned long arg)527776c53c6SMaximilian Luz static long __ssam_cdev_device_ioctl(struct ssam_cdev_client *client, unsigned int cmd,
528178f6ab7SMaximilian Luz 				     unsigned long arg)
529178f6ab7SMaximilian Luz {
530cbd224e0SMaximilian Luz 	lockdep_assert_held_read(&client->cdev->lock);
531cbd224e0SMaximilian Luz 
532178f6ab7SMaximilian Luz 	switch (cmd) {
533178f6ab7SMaximilian Luz 	case SSAM_CDEV_REQUEST:
534776c53c6SMaximilian Luz 		return ssam_cdev_request(client, (struct ssam_cdev_request __user *)arg);
535776c53c6SMaximilian Luz 
536776c53c6SMaximilian Luz 	case SSAM_CDEV_NOTIF_REGISTER:
537776c53c6SMaximilian Luz 		return ssam_cdev_notif_register(client,
538776c53c6SMaximilian Luz 						(struct ssam_cdev_notifier_desc __user *)arg);
539776c53c6SMaximilian Luz 
540776c53c6SMaximilian Luz 	case SSAM_CDEV_NOTIF_UNREGISTER:
541776c53c6SMaximilian Luz 		return ssam_cdev_notif_unregister(client,
542776c53c6SMaximilian Luz 						  (struct ssam_cdev_notifier_desc __user *)arg);
543178f6ab7SMaximilian Luz 
544e8e298a6SMaximilian Luz 	case SSAM_CDEV_EVENT_ENABLE:
545e8e298a6SMaximilian Luz 		return ssam_cdev_event_enable(client, (struct ssam_cdev_event_desc __user *)arg);
546e8e298a6SMaximilian Luz 
547e8e298a6SMaximilian Luz 	case SSAM_CDEV_EVENT_DISABLE:
548e8e298a6SMaximilian Luz 		return ssam_cdev_event_disable(client, (struct ssam_cdev_event_desc __user *)arg);
549e8e298a6SMaximilian Luz 
550178f6ab7SMaximilian Luz 	default:
551178f6ab7SMaximilian Luz 		return -ENOTTY;
552178f6ab7SMaximilian Luz 	}
553178f6ab7SMaximilian Luz }
554178f6ab7SMaximilian Luz 
ssam_cdev_device_ioctl(struct file * file,unsigned int cmd,unsigned long arg)555776c53c6SMaximilian Luz static long ssam_cdev_device_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
556178f6ab7SMaximilian Luz {
557776c53c6SMaximilian Luz 	struct ssam_cdev_client *client = file->private_data;
558178f6ab7SMaximilian Luz 	long status;
559178f6ab7SMaximilian Luz 
560178f6ab7SMaximilian Luz 	/* Ensure that controller is valid for as long as we need it. */
561776c53c6SMaximilian Luz 	if (down_read_killable(&client->cdev->lock))
562776c53c6SMaximilian Luz 		return -ERESTARTSYS;
563776c53c6SMaximilian Luz 
564776c53c6SMaximilian Luz 	if (test_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT, &client->cdev->flags)) {
565776c53c6SMaximilian Luz 		up_read(&client->cdev->lock);
566776c53c6SMaximilian Luz 		return -ENODEV;
567776c53c6SMaximilian Luz 	}
568776c53c6SMaximilian Luz 
569776c53c6SMaximilian Luz 	status = __ssam_cdev_device_ioctl(client, cmd, arg);
570776c53c6SMaximilian Luz 
571776c53c6SMaximilian Luz 	up_read(&client->cdev->lock);
572776c53c6SMaximilian Luz 	return status;
573776c53c6SMaximilian Luz }
574776c53c6SMaximilian Luz 
ssam_cdev_read(struct file * file,char __user * buf,size_t count,loff_t * offs)575776c53c6SMaximilian Luz static ssize_t ssam_cdev_read(struct file *file, char __user *buf, size_t count, loff_t *offs)
576776c53c6SMaximilian Luz {
577776c53c6SMaximilian Luz 	struct ssam_cdev_client *client = file->private_data;
578776c53c6SMaximilian Luz 	struct ssam_cdev *cdev = client->cdev;
579776c53c6SMaximilian Luz 	unsigned int copied;
580776c53c6SMaximilian Luz 	int status = 0;
581776c53c6SMaximilian Luz 
582178f6ab7SMaximilian Luz 	if (down_read_killable(&cdev->lock))
583178f6ab7SMaximilian Luz 		return -ERESTARTSYS;
584178f6ab7SMaximilian Luz 
585776c53c6SMaximilian Luz 	/* Make sure we're not shut down. */
586776c53c6SMaximilian Luz 	if (test_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT, &cdev->flags)) {
587178f6ab7SMaximilian Luz 		up_read(&cdev->lock);
588178f6ab7SMaximilian Luz 		return -ENODEV;
589178f6ab7SMaximilian Luz 	}
590178f6ab7SMaximilian Luz 
591776c53c6SMaximilian Luz 	do {
592776c53c6SMaximilian Luz 		/* Check availability, wait if necessary. */
593776c53c6SMaximilian Luz 		if (kfifo_is_empty(&client->buffer)) {
594776c53c6SMaximilian Luz 			up_read(&cdev->lock);
595178f6ab7SMaximilian Luz 
596776c53c6SMaximilian Luz 			if (file->f_flags & O_NONBLOCK)
597776c53c6SMaximilian Luz 				return -EAGAIN;
598776c53c6SMaximilian Luz 
599776c53c6SMaximilian Luz 			status = wait_event_interruptible(client->waitq,
600776c53c6SMaximilian Luz 							  !kfifo_is_empty(&client->buffer) ||
601776c53c6SMaximilian Luz 							  test_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT,
602776c53c6SMaximilian Luz 								   &cdev->flags));
603776c53c6SMaximilian Luz 			if (status < 0)
604776c53c6SMaximilian Luz 				return status;
605776c53c6SMaximilian Luz 
606776c53c6SMaximilian Luz 			if (down_read_killable(&cdev->lock))
607776c53c6SMaximilian Luz 				return -ERESTARTSYS;
608776c53c6SMaximilian Luz 
609776c53c6SMaximilian Luz 			/* Need to check that we're not shut down again. */
610776c53c6SMaximilian Luz 			if (test_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT, &cdev->flags)) {
611776c53c6SMaximilian Luz 				up_read(&cdev->lock);
612776c53c6SMaximilian Luz 				return -ENODEV;
613776c53c6SMaximilian Luz 			}
614776c53c6SMaximilian Luz 		}
615776c53c6SMaximilian Luz 
616776c53c6SMaximilian Luz 		/* Try to read from FIFO. */
617776c53c6SMaximilian Luz 		if (mutex_lock_interruptible(&client->read_lock)) {
618776c53c6SMaximilian Luz 			up_read(&cdev->lock);
619776c53c6SMaximilian Luz 			return -ERESTARTSYS;
620776c53c6SMaximilian Luz 		}
621776c53c6SMaximilian Luz 
622776c53c6SMaximilian Luz 		status = kfifo_to_user(&client->buffer, buf, count, &copied);
623776c53c6SMaximilian Luz 		mutex_unlock(&client->read_lock);
624776c53c6SMaximilian Luz 
625776c53c6SMaximilian Luz 		if (status < 0) {
626178f6ab7SMaximilian Luz 			up_read(&cdev->lock);
627178f6ab7SMaximilian Luz 			return status;
628178f6ab7SMaximilian Luz 		}
629178f6ab7SMaximilian Luz 
630776c53c6SMaximilian Luz 		/* We might not have gotten anything, check this here. */
631776c53c6SMaximilian Luz 		if (copied == 0 && (file->f_flags & O_NONBLOCK)) {
632776c53c6SMaximilian Luz 			up_read(&cdev->lock);
633776c53c6SMaximilian Luz 			return -EAGAIN;
634776c53c6SMaximilian Luz 		}
635776c53c6SMaximilian Luz 	} while (copied == 0);
636776c53c6SMaximilian Luz 
637776c53c6SMaximilian Luz 	up_read(&cdev->lock);
638776c53c6SMaximilian Luz 	return copied;
639776c53c6SMaximilian Luz }
640776c53c6SMaximilian Luz 
ssam_cdev_poll(struct file * file,struct poll_table_struct * pt)641776c53c6SMaximilian Luz static __poll_t ssam_cdev_poll(struct file *file, struct poll_table_struct *pt)
642776c53c6SMaximilian Luz {
643776c53c6SMaximilian Luz 	struct ssam_cdev_client *client = file->private_data;
644776c53c6SMaximilian Luz 	__poll_t events = 0;
645776c53c6SMaximilian Luz 
646776c53c6SMaximilian Luz 	if (test_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT, &client->cdev->flags))
647776c53c6SMaximilian Luz 		return EPOLLHUP | EPOLLERR;
648776c53c6SMaximilian Luz 
649776c53c6SMaximilian Luz 	poll_wait(file, &client->waitq, pt);
650776c53c6SMaximilian Luz 
651776c53c6SMaximilian Luz 	if (!kfifo_is_empty(&client->buffer))
652776c53c6SMaximilian Luz 		events |= EPOLLIN | EPOLLRDNORM;
653776c53c6SMaximilian Luz 
654776c53c6SMaximilian Luz 	return events;
655776c53c6SMaximilian Luz }
656776c53c6SMaximilian Luz 
ssam_cdev_fasync(int fd,struct file * file,int on)657776c53c6SMaximilian Luz static int ssam_cdev_fasync(int fd, struct file *file, int on)
658776c53c6SMaximilian Luz {
659776c53c6SMaximilian Luz 	struct ssam_cdev_client *client = file->private_data;
660776c53c6SMaximilian Luz 
661776c53c6SMaximilian Luz 	return fasync_helper(fd, file, on, &client->fasync);
662776c53c6SMaximilian Luz }
663776c53c6SMaximilian Luz 
664178f6ab7SMaximilian Luz static const struct file_operations ssam_controller_fops = {
665178f6ab7SMaximilian Luz 	.owner          = THIS_MODULE,
666178f6ab7SMaximilian Luz 	.open           = ssam_cdev_device_open,
667178f6ab7SMaximilian Luz 	.release        = ssam_cdev_device_release,
668776c53c6SMaximilian Luz 	.read           = ssam_cdev_read,
669776c53c6SMaximilian Luz 	.poll           = ssam_cdev_poll,
670776c53c6SMaximilian Luz 	.fasync         = ssam_cdev_fasync,
671178f6ab7SMaximilian Luz 	.unlocked_ioctl = ssam_cdev_device_ioctl,
672178f6ab7SMaximilian Luz 	.compat_ioctl   = ssam_cdev_device_ioctl,
673776c53c6SMaximilian Luz 	.llseek         = no_llseek,
674178f6ab7SMaximilian Luz };
675178f6ab7SMaximilian Luz 
676776c53c6SMaximilian Luz 
677776c53c6SMaximilian Luz /* -- Device and driver setup ----------------------------------------------- */
678776c53c6SMaximilian Luz 
ssam_dbg_device_probe(struct platform_device * pdev)679178f6ab7SMaximilian Luz static int ssam_dbg_device_probe(struct platform_device *pdev)
680178f6ab7SMaximilian Luz {
681178f6ab7SMaximilian Luz 	struct ssam_controller *ctrl;
682178f6ab7SMaximilian Luz 	struct ssam_cdev *cdev;
683178f6ab7SMaximilian Luz 	int status;
684178f6ab7SMaximilian Luz 
685178f6ab7SMaximilian Luz 	ctrl = ssam_client_bind(&pdev->dev);
686178f6ab7SMaximilian Luz 	if (IS_ERR(ctrl))
687178f6ab7SMaximilian Luz 		return PTR_ERR(ctrl) == -ENODEV ? -EPROBE_DEFER : PTR_ERR(ctrl);
688178f6ab7SMaximilian Luz 
689178f6ab7SMaximilian Luz 	cdev = kzalloc(sizeof(*cdev), GFP_KERNEL);
690178f6ab7SMaximilian Luz 	if (!cdev)
691178f6ab7SMaximilian Luz 		return -ENOMEM;
692178f6ab7SMaximilian Luz 
693178f6ab7SMaximilian Luz 	kref_init(&cdev->kref);
694178f6ab7SMaximilian Luz 	init_rwsem(&cdev->lock);
695178f6ab7SMaximilian Luz 	cdev->ctrl = ctrl;
696776c53c6SMaximilian Luz 	cdev->dev = &pdev->dev;
697178f6ab7SMaximilian Luz 
698178f6ab7SMaximilian Luz 	cdev->mdev.parent   = &pdev->dev;
699178f6ab7SMaximilian Luz 	cdev->mdev.minor    = MISC_DYNAMIC_MINOR;
700178f6ab7SMaximilian Luz 	cdev->mdev.name     = "surface_aggregator";
701178f6ab7SMaximilian Luz 	cdev->mdev.nodename = "surface/aggregator";
702178f6ab7SMaximilian Luz 	cdev->mdev.fops     = &ssam_controller_fops;
703178f6ab7SMaximilian Luz 
704776c53c6SMaximilian Luz 	init_rwsem(&cdev->client_lock);
705776c53c6SMaximilian Luz 	INIT_LIST_HEAD(&cdev->client_list);
706776c53c6SMaximilian Luz 
707178f6ab7SMaximilian Luz 	status = misc_register(&cdev->mdev);
708178f6ab7SMaximilian Luz 	if (status) {
709178f6ab7SMaximilian Luz 		kfree(cdev);
710178f6ab7SMaximilian Luz 		return status;
711178f6ab7SMaximilian Luz 	}
712178f6ab7SMaximilian Luz 
713178f6ab7SMaximilian Luz 	platform_set_drvdata(pdev, cdev);
714178f6ab7SMaximilian Luz 	return 0;
715178f6ab7SMaximilian Luz }
716178f6ab7SMaximilian Luz 
ssam_dbg_device_remove(struct platform_device * pdev)717178f6ab7SMaximilian Luz static int ssam_dbg_device_remove(struct platform_device *pdev)
718178f6ab7SMaximilian Luz {
719178f6ab7SMaximilian Luz 	struct ssam_cdev *cdev = platform_get_drvdata(pdev);
720776c53c6SMaximilian Luz 	struct ssam_cdev_client *client;
721178f6ab7SMaximilian Luz 
722776c53c6SMaximilian Luz 	/*
723776c53c6SMaximilian Luz 	 * Mark device as shut-down. Prevent new clients from being added and
724776c53c6SMaximilian Luz 	 * new operations from being executed.
725776c53c6SMaximilian Luz 	 */
726776c53c6SMaximilian Luz 	set_bit(SSAM_CDEV_DEVICE_SHUTDOWN_BIT, &cdev->flags);
727776c53c6SMaximilian Luz 
728776c53c6SMaximilian Luz 	down_write(&cdev->client_lock);
729776c53c6SMaximilian Luz 
730776c53c6SMaximilian Luz 	/* Remove all notifiers registered by us. */
731776c53c6SMaximilian Luz 	list_for_each_entry(client, &cdev->client_list, node) {
732776c53c6SMaximilian Luz 		ssam_cdev_notifier_unregister_all(client);
733776c53c6SMaximilian Luz 	}
734776c53c6SMaximilian Luz 
735776c53c6SMaximilian Luz 	/* Wake up async clients. */
736776c53c6SMaximilian Luz 	list_for_each_entry(client, &cdev->client_list, node) {
737776c53c6SMaximilian Luz 		kill_fasync(&client->fasync, SIGIO, POLL_HUP);
738776c53c6SMaximilian Luz 	}
739776c53c6SMaximilian Luz 
740776c53c6SMaximilian Luz 	/* Wake up blocking clients. */
741776c53c6SMaximilian Luz 	list_for_each_entry(client, &cdev->client_list, node) {
742776c53c6SMaximilian Luz 		wake_up_interruptible(&client->waitq);
743776c53c6SMaximilian Luz 	}
744776c53c6SMaximilian Luz 
745776c53c6SMaximilian Luz 	up_write(&cdev->client_lock);
746178f6ab7SMaximilian Luz 
747178f6ab7SMaximilian Luz 	/*
748178f6ab7SMaximilian Luz 	 * The controller is only guaranteed to be valid for as long as the
749178f6ab7SMaximilian Luz 	 * driver is bound. Remove controller so that any lingering open files
750178f6ab7SMaximilian Luz 	 * cannot access it any more after we're gone.
751178f6ab7SMaximilian Luz 	 */
752178f6ab7SMaximilian Luz 	down_write(&cdev->lock);
753178f6ab7SMaximilian Luz 	cdev->ctrl = NULL;
754776c53c6SMaximilian Luz 	cdev->dev = NULL;
755178f6ab7SMaximilian Luz 	up_write(&cdev->lock);
756178f6ab7SMaximilian Luz 
757776c53c6SMaximilian Luz 	misc_deregister(&cdev->mdev);
758776c53c6SMaximilian Luz 
759178f6ab7SMaximilian Luz 	ssam_cdev_put(cdev);
760178f6ab7SMaximilian Luz 	return 0;
761178f6ab7SMaximilian Luz }
762178f6ab7SMaximilian Luz 
763178f6ab7SMaximilian Luz static struct platform_device *ssam_cdev_device;
764178f6ab7SMaximilian Luz 
765178f6ab7SMaximilian Luz static struct platform_driver ssam_cdev_driver = {
766178f6ab7SMaximilian Luz 	.probe = ssam_dbg_device_probe,
767178f6ab7SMaximilian Luz 	.remove = ssam_dbg_device_remove,
768178f6ab7SMaximilian Luz 	.driver = {
769178f6ab7SMaximilian Luz 		.name = SSAM_CDEV_DEVICE_NAME,
770178f6ab7SMaximilian Luz 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
771178f6ab7SMaximilian Luz 	},
772178f6ab7SMaximilian Luz };
773178f6ab7SMaximilian Luz 
ssam_debug_init(void)774178f6ab7SMaximilian Luz static int __init ssam_debug_init(void)
775178f6ab7SMaximilian Luz {
776178f6ab7SMaximilian Luz 	int status;
777178f6ab7SMaximilian Luz 
778178f6ab7SMaximilian Luz 	ssam_cdev_device = platform_device_alloc(SSAM_CDEV_DEVICE_NAME,
779178f6ab7SMaximilian Luz 						 PLATFORM_DEVID_NONE);
780178f6ab7SMaximilian Luz 	if (!ssam_cdev_device)
781178f6ab7SMaximilian Luz 		return -ENOMEM;
782178f6ab7SMaximilian Luz 
783178f6ab7SMaximilian Luz 	status = platform_device_add(ssam_cdev_device);
784178f6ab7SMaximilian Luz 	if (status)
785178f6ab7SMaximilian Luz 		goto err_device;
786178f6ab7SMaximilian Luz 
787178f6ab7SMaximilian Luz 	status = platform_driver_register(&ssam_cdev_driver);
788178f6ab7SMaximilian Luz 	if (status)
789178f6ab7SMaximilian Luz 		goto err_driver;
790178f6ab7SMaximilian Luz 
791178f6ab7SMaximilian Luz 	return 0;
792178f6ab7SMaximilian Luz 
793178f6ab7SMaximilian Luz err_driver:
794178f6ab7SMaximilian Luz 	platform_device_del(ssam_cdev_device);
795178f6ab7SMaximilian Luz err_device:
796178f6ab7SMaximilian Luz 	platform_device_put(ssam_cdev_device);
797178f6ab7SMaximilian Luz 	return status;
798178f6ab7SMaximilian Luz }
799178f6ab7SMaximilian Luz module_init(ssam_debug_init);
800178f6ab7SMaximilian Luz 
ssam_debug_exit(void)801178f6ab7SMaximilian Luz static void __exit ssam_debug_exit(void)
802178f6ab7SMaximilian Luz {
803178f6ab7SMaximilian Luz 	platform_driver_unregister(&ssam_cdev_driver);
804178f6ab7SMaximilian Luz 	platform_device_unregister(ssam_cdev_device);
805178f6ab7SMaximilian Luz }
806178f6ab7SMaximilian Luz module_exit(ssam_debug_exit);
807178f6ab7SMaximilian Luz 
808178f6ab7SMaximilian Luz MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
809178f6ab7SMaximilian Luz MODULE_DESCRIPTION("User-space interface for Surface System Aggregator Module");
810178f6ab7SMaximilian Luz MODULE_LICENSE("GPL");
811