2 * Greybus driver for the Raw protocol
4 * Copyright 2015 Google Inc.
5 * Copyright 2015 Linaro Ltd.
7 * Released under the GPLv2 only.
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/slab.h>
12 #include <linux/sizes.h>
13 #include <linux/cdev.h>
15 #include <linux/idr.h>
16 #include <linux/uaccess.h>
21 struct gb_connection
*connection
;
23 struct list_head list
;
25 struct mutex list_lock
;
28 struct device
*device
;
32 struct list_head entry
;
37 static struct class *raw_class
;
39 static const struct file_operations raw_fops
;
40 static DEFINE_IDA(minors
);
42 /* Number of minor devices this driver supports */
43 #define NUM_MINORS 256
45 /* Maximum size of any one send data buffer we support */
46 #define MAX_PACKET_SIZE (PAGE_SIZE * 2)
49 * Maximum size of the data in the receive buffer we allow before we start to
50 * drop messages on the floor
52 #define MAX_DATA_SIZE (MAX_PACKET_SIZE * 8)
55 * Add the raw data message to the list of received messages.
57 static int receive_data(struct gb_raw
*raw
, u32 len
, u8
*data
)
59 struct raw_data
*raw_data
;
60 struct device
*dev
= &raw
->connection
->bundle
->dev
;
63 if (len
> MAX_PACKET_SIZE
) {
64 dev_err(dev
, "Too big of a data packet, rejected\n");
68 mutex_lock(&raw
->list_lock
);
69 if ((raw
->list_data
+ len
) > MAX_DATA_SIZE
) {
70 dev_err(dev
, "Too much data in receive buffer, now dropping packets\n");
75 raw_data
= kmalloc(sizeof(*raw_data
) + len
, GFP_KERNEL
);
81 raw
->list_data
+= len
;
83 memcpy(&raw_data
->data
[0], data
, len
);
85 list_add_tail(&raw_data
->entry
, &raw
->list
);
87 mutex_unlock(&raw
->list_lock
);
91 static int gb_raw_request_handler(struct gb_operation
*op
)
93 struct gb_connection
*connection
= op
->connection
;
94 struct device
*dev
= &connection
->bundle
->dev
;
95 struct gb_raw
*raw
= greybus_get_drvdata(connection
->bundle
);
96 struct gb_raw_send_request
*receive
;
99 if (op
->type
!= GB_RAW_TYPE_SEND
) {
100 dev_err(dev
, "unknown request type 0x%02x\n", op
->type
);
104 /* Verify size of payload */
105 if (op
->request
->payload_size
< sizeof(*receive
)) {
106 dev_err(dev
, "raw receive request too small (%zu < %zu)\n",
107 op
->request
->payload_size
, sizeof(*receive
));
110 receive
= op
->request
->payload
;
111 len
= le32_to_cpu(receive
->len
);
112 if (len
!= (int)(op
->request
->payload_size
- sizeof(__le32
))) {
113 dev_err(dev
, "raw receive request wrong size %d vs %d\n", len
,
114 (int)(op
->request
->payload_size
- sizeof(__le32
)));
118 dev_err(dev
, "raw receive request of 0 bytes?\n");
122 return receive_data(raw
, len
, receive
->data
);
125 static int gb_raw_send(struct gb_raw
*raw
, u32 len
, const char __user
*data
)
127 struct gb_connection
*connection
= raw
->connection
;
128 struct gb_raw_send_request
*request
;
131 request
= kmalloc(len
+ sizeof(*request
), GFP_KERNEL
);
135 if (copy_from_user(&request
->data
[0], data
, len
)) {
140 request
->len
= cpu_to_le32(len
);
142 retval
= gb_operation_sync(connection
, GB_RAW_TYPE_SEND
,
143 request
, len
+ sizeof(*request
),
150 static int gb_raw_probe(struct gb_bundle
*bundle
,
151 const struct greybus_bundle_id
*id
)
153 struct greybus_descriptor_cport
*cport_desc
;
154 struct gb_connection
*connection
;
159 if (bundle
->num_cports
!= 1)
162 cport_desc
= &bundle
->cport_desc
[0];
163 if (cport_desc
->protocol_id
!= GREYBUS_PROTOCOL_RAW
)
166 raw
= kzalloc(sizeof(*raw
), GFP_KERNEL
);
170 connection
= gb_connection_create(bundle
, le16_to_cpu(cport_desc
->id
),
171 gb_raw_request_handler
);
172 if (IS_ERR(connection
)) {
173 retval
= PTR_ERR(connection
);
177 INIT_LIST_HEAD(&raw
->list
);
178 mutex_init(&raw
->list_lock
);
180 raw
->connection
= connection
;
181 greybus_set_drvdata(bundle
, raw
);
183 minor
= ida_simple_get(&minors
, 0, 0, GFP_KERNEL
);
186 goto error_connection_destroy
;
189 raw
->dev
= MKDEV(raw_major
, minor
);
190 cdev_init(&raw
->cdev
, &raw_fops
);
192 retval
= gb_connection_enable(connection
);
194 goto error_remove_ida
;
196 retval
= cdev_add(&raw
->cdev
, raw
->dev
, 1);
198 goto error_connection_disable
;
200 raw
->device
= device_create(raw_class
, &connection
->bundle
->dev
,
201 raw
->dev
, raw
, "gb!raw%d", minor
);
202 if (IS_ERR(raw
->device
)) {
203 retval
= PTR_ERR(raw
->device
);
210 cdev_del(&raw
->cdev
);
212 error_connection_disable
:
213 gb_connection_disable(connection
);
216 ida_simple_remove(&minors
, minor
);
218 error_connection_destroy
:
219 gb_connection_destroy(connection
);
226 static void gb_raw_disconnect(struct gb_bundle
*bundle
)
228 struct gb_raw
*raw
= greybus_get_drvdata(bundle
);
229 struct gb_connection
*connection
= raw
->connection
;
230 struct raw_data
*raw_data
;
231 struct raw_data
*temp
;
233 // FIXME - handle removing a connection when the char device node is open.
234 device_destroy(raw_class
, raw
->dev
);
235 cdev_del(&raw
->cdev
);
236 gb_connection_disable(connection
);
237 ida_simple_remove(&minors
, MINOR(raw
->dev
));
238 gb_connection_destroy(connection
);
240 mutex_lock(&raw
->list_lock
);
241 list_for_each_entry_safe(raw_data
, temp
, &raw
->list
, entry
) {
242 list_del(&raw_data
->entry
);
245 mutex_unlock(&raw
->list_lock
);
251 * Character device node interfaces.
253 * Note, we are using read/write to only allow a single read/write per message.
254 * This means for read(), you have to provide a big enough buffer for the full
255 * message to be copied into. If the buffer isn't big enough, the read() will
259 static int raw_open(struct inode
*inode
, struct file
*file
)
261 struct cdev
*cdev
= inode
->i_cdev
;
262 struct gb_raw
*raw
= container_of(cdev
, struct gb_raw
, cdev
);
264 file
->private_data
= raw
;
268 static ssize_t
raw_write(struct file
*file
, const char __user
*buf
,
269 size_t count
, loff_t
*ppos
)
271 struct gb_raw
*raw
= file
->private_data
;
277 if (count
> MAX_PACKET_SIZE
)
280 retval
= gb_raw_send(raw
, count
, buf
);
287 static ssize_t
raw_read(struct file
*file
, char __user
*buf
, size_t count
,
290 struct gb_raw
*raw
= file
->private_data
;
292 struct raw_data
*raw_data
;
294 mutex_lock(&raw
->list_lock
);
295 if (list_empty(&raw
->list
))
298 raw_data
= list_first_entry(&raw
->list
, struct raw_data
, entry
);
299 if (raw_data
->len
> count
) {
304 if (copy_to_user(buf
, &raw_data
->data
[0], raw_data
->len
)) {
309 list_del(&raw_data
->entry
);
310 raw
->list_data
-= raw_data
->len
;
311 retval
= raw_data
->len
;
315 mutex_unlock(&raw
->list_lock
);
319 static const struct file_operations raw_fops
= {
320 .owner
= THIS_MODULE
,
324 .llseek
= noop_llseek
,
327 static const struct greybus_bundle_id gb_raw_id_table
[] = {
328 { GREYBUS_DEVICE_CLASS(GREYBUS_CLASS_RAW
) },
331 MODULE_DEVICE_TABLE(greybus
, gb_raw_id_table
);
333 static struct greybus_driver gb_raw_driver
= {
335 .probe
= gb_raw_probe
,
336 .disconnect
= gb_raw_disconnect
,
337 .id_table
= gb_raw_id_table
,
340 static int raw_init(void)
345 raw_class
= class_create(THIS_MODULE
, "gb_raw");
346 if (IS_ERR(raw_class
)) {
347 retval
= PTR_ERR(raw_class
);
351 retval
= alloc_chrdev_region(&dev
, 0, NUM_MINORS
, "gb_raw");
355 raw_major
= MAJOR(dev
);
357 retval
= greybus_register(&gb_raw_driver
);
364 unregister_chrdev_region(dev
, NUM_MINORS
);
366 class_destroy(raw_class
);
370 module_init(raw_init
);
372 static void __exit
raw_exit(void)
374 greybus_deregister(&gb_raw_driver
);
375 unregister_chrdev_region(MKDEV(raw_major
, 0), NUM_MINORS
);
376 class_destroy(raw_class
);
377 ida_destroy(&minors
);
379 module_exit(raw_exit
);
381 MODULE_LICENSE("GPL v2");