1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Bluetooth virtual HCI driver
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * Copyright (C) 2000-2001 Qualcomm Incorporated
7*4882a593Smuzhiyun * Copyright (C) 2002-2003 Maxim Krasnyansky <maxk@qualcomm.com>
8*4882a593Smuzhiyun * Copyright (C) 2004-2006 Marcel Holtmann <marcel@holtmann.org>
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/module.h>
12*4882a593Smuzhiyun #include <asm/unaligned.h>
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun #include <linux/kernel.h>
15*4882a593Smuzhiyun #include <linux/init.h>
16*4882a593Smuzhiyun #include <linux/slab.h>
17*4882a593Smuzhiyun #include <linux/types.h>
18*4882a593Smuzhiyun #include <linux/errno.h>
19*4882a593Smuzhiyun #include <linux/sched.h>
20*4882a593Smuzhiyun #include <linux/poll.h>
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun #include <linux/skbuff.h>
23*4882a593Smuzhiyun #include <linux/miscdevice.h>
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun #include <net/bluetooth/bluetooth.h>
26*4882a593Smuzhiyun #include <net/bluetooth/hci_core.h>
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun #define VERSION "1.5"
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun static bool amp;
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun struct vhci_data {
33*4882a593Smuzhiyun struct hci_dev *hdev;
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun wait_queue_head_t read_wait;
36*4882a593Smuzhiyun struct sk_buff_head readq;
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun struct mutex open_mutex;
39*4882a593Smuzhiyun struct delayed_work open_timeout;
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun
vhci_open_dev(struct hci_dev * hdev)42*4882a593Smuzhiyun static int vhci_open_dev(struct hci_dev *hdev)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun return 0;
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun
vhci_close_dev(struct hci_dev * hdev)47*4882a593Smuzhiyun static int vhci_close_dev(struct hci_dev *hdev)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun struct vhci_data *data = hci_get_drvdata(hdev);
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun skb_queue_purge(&data->readq);
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun return 0;
54*4882a593Smuzhiyun }
55*4882a593Smuzhiyun
vhci_flush(struct hci_dev * hdev)56*4882a593Smuzhiyun static int vhci_flush(struct hci_dev *hdev)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun struct vhci_data *data = hci_get_drvdata(hdev);
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun skb_queue_purge(&data->readq);
61*4882a593Smuzhiyun
62*4882a593Smuzhiyun return 0;
63*4882a593Smuzhiyun }
64*4882a593Smuzhiyun
vhci_send_frame(struct hci_dev * hdev,struct sk_buff * skb)65*4882a593Smuzhiyun static int vhci_send_frame(struct hci_dev *hdev, struct sk_buff *skb)
66*4882a593Smuzhiyun {
67*4882a593Smuzhiyun struct vhci_data *data = hci_get_drvdata(hdev);
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun memcpy(skb_push(skb, 1), &hci_skb_pkt_type(skb), 1);
70*4882a593Smuzhiyun skb_queue_tail(&data->readq, skb);
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun wake_up_interruptible(&data->read_wait);
73*4882a593Smuzhiyun return 0;
74*4882a593Smuzhiyun }
75*4882a593Smuzhiyun
__vhci_create_device(struct vhci_data * data,__u8 opcode)76*4882a593Smuzhiyun static int __vhci_create_device(struct vhci_data *data, __u8 opcode)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun struct hci_dev *hdev;
79*4882a593Smuzhiyun struct sk_buff *skb;
80*4882a593Smuzhiyun __u8 dev_type;
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun if (data->hdev)
83*4882a593Smuzhiyun return -EBADFD;
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun /* bits 0-1 are dev_type (Primary or AMP) */
86*4882a593Smuzhiyun dev_type = opcode & 0x03;
87*4882a593Smuzhiyun
88*4882a593Smuzhiyun if (dev_type != HCI_PRIMARY && dev_type != HCI_AMP)
89*4882a593Smuzhiyun return -EINVAL;
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun /* bits 2-5 are reserved (must be zero) */
92*4882a593Smuzhiyun if (opcode & 0x3c)
93*4882a593Smuzhiyun return -EINVAL;
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun skb = bt_skb_alloc(4, GFP_KERNEL);
96*4882a593Smuzhiyun if (!skb)
97*4882a593Smuzhiyun return -ENOMEM;
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun hdev = hci_alloc_dev();
100*4882a593Smuzhiyun if (!hdev) {
101*4882a593Smuzhiyun kfree_skb(skb);
102*4882a593Smuzhiyun return -ENOMEM;
103*4882a593Smuzhiyun }
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun data->hdev = hdev;
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun hdev->bus = HCI_VIRTUAL;
108*4882a593Smuzhiyun hdev->dev_type = dev_type;
109*4882a593Smuzhiyun hci_set_drvdata(hdev, data);
110*4882a593Smuzhiyun
111*4882a593Smuzhiyun hdev->open = vhci_open_dev;
112*4882a593Smuzhiyun hdev->close = vhci_close_dev;
113*4882a593Smuzhiyun hdev->flush = vhci_flush;
114*4882a593Smuzhiyun hdev->send = vhci_send_frame;
115*4882a593Smuzhiyun
116*4882a593Smuzhiyun /* bit 6 is for external configuration */
117*4882a593Smuzhiyun if (opcode & 0x40)
118*4882a593Smuzhiyun set_bit(HCI_QUIRK_EXTERNAL_CONFIG, &hdev->quirks);
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun /* bit 7 is for raw device */
121*4882a593Smuzhiyun if (opcode & 0x80)
122*4882a593Smuzhiyun set_bit(HCI_QUIRK_RAW_DEVICE, &hdev->quirks);
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun set_bit(HCI_QUIRK_VALID_LE_STATES, &hdev->quirks);
125*4882a593Smuzhiyun
126*4882a593Smuzhiyun if (hci_register_dev(hdev) < 0) {
127*4882a593Smuzhiyun BT_ERR("Can't register HCI device");
128*4882a593Smuzhiyun hci_free_dev(hdev);
129*4882a593Smuzhiyun data->hdev = NULL;
130*4882a593Smuzhiyun kfree_skb(skb);
131*4882a593Smuzhiyun return -EBUSY;
132*4882a593Smuzhiyun }
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun hci_skb_pkt_type(skb) = HCI_VENDOR_PKT;
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun skb_put_u8(skb, 0xff);
137*4882a593Smuzhiyun skb_put_u8(skb, opcode);
138*4882a593Smuzhiyun put_unaligned_le16(hdev->id, skb_put(skb, 2));
139*4882a593Smuzhiyun skb_queue_tail(&data->readq, skb);
140*4882a593Smuzhiyun
141*4882a593Smuzhiyun wake_up_interruptible(&data->read_wait);
142*4882a593Smuzhiyun return 0;
143*4882a593Smuzhiyun }
144*4882a593Smuzhiyun
vhci_create_device(struct vhci_data * data,__u8 opcode)145*4882a593Smuzhiyun static int vhci_create_device(struct vhci_data *data, __u8 opcode)
146*4882a593Smuzhiyun {
147*4882a593Smuzhiyun int err;
148*4882a593Smuzhiyun
149*4882a593Smuzhiyun mutex_lock(&data->open_mutex);
150*4882a593Smuzhiyun err = __vhci_create_device(data, opcode);
151*4882a593Smuzhiyun mutex_unlock(&data->open_mutex);
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun return err;
154*4882a593Smuzhiyun }
155*4882a593Smuzhiyun
vhci_get_user(struct vhci_data * data,struct iov_iter * from)156*4882a593Smuzhiyun static inline ssize_t vhci_get_user(struct vhci_data *data,
157*4882a593Smuzhiyun struct iov_iter *from)
158*4882a593Smuzhiyun {
159*4882a593Smuzhiyun size_t len = iov_iter_count(from);
160*4882a593Smuzhiyun struct sk_buff *skb;
161*4882a593Smuzhiyun __u8 pkt_type, opcode;
162*4882a593Smuzhiyun int ret;
163*4882a593Smuzhiyun
164*4882a593Smuzhiyun if (len < 2 || len > HCI_MAX_FRAME_SIZE)
165*4882a593Smuzhiyun return -EINVAL;
166*4882a593Smuzhiyun
167*4882a593Smuzhiyun skb = bt_skb_alloc(len, GFP_KERNEL);
168*4882a593Smuzhiyun if (!skb)
169*4882a593Smuzhiyun return -ENOMEM;
170*4882a593Smuzhiyun
171*4882a593Smuzhiyun if (!copy_from_iter_full(skb_put(skb, len), len, from)) {
172*4882a593Smuzhiyun kfree_skb(skb);
173*4882a593Smuzhiyun return -EFAULT;
174*4882a593Smuzhiyun }
175*4882a593Smuzhiyun
176*4882a593Smuzhiyun pkt_type = *((__u8 *) skb->data);
177*4882a593Smuzhiyun skb_pull(skb, 1);
178*4882a593Smuzhiyun
179*4882a593Smuzhiyun switch (pkt_type) {
180*4882a593Smuzhiyun case HCI_EVENT_PKT:
181*4882a593Smuzhiyun case HCI_ACLDATA_PKT:
182*4882a593Smuzhiyun case HCI_SCODATA_PKT:
183*4882a593Smuzhiyun case HCI_ISODATA_PKT:
184*4882a593Smuzhiyun if (!data->hdev) {
185*4882a593Smuzhiyun kfree_skb(skb);
186*4882a593Smuzhiyun return -ENODEV;
187*4882a593Smuzhiyun }
188*4882a593Smuzhiyun
189*4882a593Smuzhiyun hci_skb_pkt_type(skb) = pkt_type;
190*4882a593Smuzhiyun
191*4882a593Smuzhiyun ret = hci_recv_frame(data->hdev, skb);
192*4882a593Smuzhiyun break;
193*4882a593Smuzhiyun
194*4882a593Smuzhiyun case HCI_VENDOR_PKT:
195*4882a593Smuzhiyun cancel_delayed_work_sync(&data->open_timeout);
196*4882a593Smuzhiyun
197*4882a593Smuzhiyun opcode = *((__u8 *) skb->data);
198*4882a593Smuzhiyun skb_pull(skb, 1);
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun if (skb->len > 0) {
201*4882a593Smuzhiyun kfree_skb(skb);
202*4882a593Smuzhiyun return -EINVAL;
203*4882a593Smuzhiyun }
204*4882a593Smuzhiyun
205*4882a593Smuzhiyun kfree_skb(skb);
206*4882a593Smuzhiyun
207*4882a593Smuzhiyun ret = vhci_create_device(data, opcode);
208*4882a593Smuzhiyun break;
209*4882a593Smuzhiyun
210*4882a593Smuzhiyun default:
211*4882a593Smuzhiyun kfree_skb(skb);
212*4882a593Smuzhiyun return -EINVAL;
213*4882a593Smuzhiyun }
214*4882a593Smuzhiyun
215*4882a593Smuzhiyun return (ret < 0) ? ret : len;
216*4882a593Smuzhiyun }
217*4882a593Smuzhiyun
vhci_put_user(struct vhci_data * data,struct sk_buff * skb,char __user * buf,int count)218*4882a593Smuzhiyun static inline ssize_t vhci_put_user(struct vhci_data *data,
219*4882a593Smuzhiyun struct sk_buff *skb,
220*4882a593Smuzhiyun char __user *buf, int count)
221*4882a593Smuzhiyun {
222*4882a593Smuzhiyun char __user *ptr = buf;
223*4882a593Smuzhiyun int len;
224*4882a593Smuzhiyun
225*4882a593Smuzhiyun len = min_t(unsigned int, skb->len, count);
226*4882a593Smuzhiyun
227*4882a593Smuzhiyun if (copy_to_user(ptr, skb->data, len))
228*4882a593Smuzhiyun return -EFAULT;
229*4882a593Smuzhiyun
230*4882a593Smuzhiyun if (!data->hdev)
231*4882a593Smuzhiyun return len;
232*4882a593Smuzhiyun
233*4882a593Smuzhiyun data->hdev->stat.byte_tx += len;
234*4882a593Smuzhiyun
235*4882a593Smuzhiyun switch (hci_skb_pkt_type(skb)) {
236*4882a593Smuzhiyun case HCI_COMMAND_PKT:
237*4882a593Smuzhiyun data->hdev->stat.cmd_tx++;
238*4882a593Smuzhiyun break;
239*4882a593Smuzhiyun case HCI_ACLDATA_PKT:
240*4882a593Smuzhiyun data->hdev->stat.acl_tx++;
241*4882a593Smuzhiyun break;
242*4882a593Smuzhiyun case HCI_SCODATA_PKT:
243*4882a593Smuzhiyun data->hdev->stat.sco_tx++;
244*4882a593Smuzhiyun break;
245*4882a593Smuzhiyun }
246*4882a593Smuzhiyun
247*4882a593Smuzhiyun return len;
248*4882a593Smuzhiyun }
249*4882a593Smuzhiyun
vhci_read(struct file * file,char __user * buf,size_t count,loff_t * pos)250*4882a593Smuzhiyun static ssize_t vhci_read(struct file *file,
251*4882a593Smuzhiyun char __user *buf, size_t count, loff_t *pos)
252*4882a593Smuzhiyun {
253*4882a593Smuzhiyun struct vhci_data *data = file->private_data;
254*4882a593Smuzhiyun struct sk_buff *skb;
255*4882a593Smuzhiyun ssize_t ret = 0;
256*4882a593Smuzhiyun
257*4882a593Smuzhiyun while (count) {
258*4882a593Smuzhiyun skb = skb_dequeue(&data->readq);
259*4882a593Smuzhiyun if (skb) {
260*4882a593Smuzhiyun ret = vhci_put_user(data, skb, buf, count);
261*4882a593Smuzhiyun if (ret < 0)
262*4882a593Smuzhiyun skb_queue_head(&data->readq, skb);
263*4882a593Smuzhiyun else
264*4882a593Smuzhiyun kfree_skb(skb);
265*4882a593Smuzhiyun break;
266*4882a593Smuzhiyun }
267*4882a593Smuzhiyun
268*4882a593Smuzhiyun if (file->f_flags & O_NONBLOCK) {
269*4882a593Smuzhiyun ret = -EAGAIN;
270*4882a593Smuzhiyun break;
271*4882a593Smuzhiyun }
272*4882a593Smuzhiyun
273*4882a593Smuzhiyun ret = wait_event_interruptible(data->read_wait,
274*4882a593Smuzhiyun !skb_queue_empty(&data->readq));
275*4882a593Smuzhiyun if (ret < 0)
276*4882a593Smuzhiyun break;
277*4882a593Smuzhiyun }
278*4882a593Smuzhiyun
279*4882a593Smuzhiyun return ret;
280*4882a593Smuzhiyun }
281*4882a593Smuzhiyun
vhci_write(struct kiocb * iocb,struct iov_iter * from)282*4882a593Smuzhiyun static ssize_t vhci_write(struct kiocb *iocb, struct iov_iter *from)
283*4882a593Smuzhiyun {
284*4882a593Smuzhiyun struct file *file = iocb->ki_filp;
285*4882a593Smuzhiyun struct vhci_data *data = file->private_data;
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun return vhci_get_user(data, from);
288*4882a593Smuzhiyun }
289*4882a593Smuzhiyun
vhci_poll(struct file * file,poll_table * wait)290*4882a593Smuzhiyun static __poll_t vhci_poll(struct file *file, poll_table *wait)
291*4882a593Smuzhiyun {
292*4882a593Smuzhiyun struct vhci_data *data = file->private_data;
293*4882a593Smuzhiyun
294*4882a593Smuzhiyun poll_wait(file, &data->read_wait, wait);
295*4882a593Smuzhiyun
296*4882a593Smuzhiyun if (!skb_queue_empty(&data->readq))
297*4882a593Smuzhiyun return EPOLLIN | EPOLLRDNORM;
298*4882a593Smuzhiyun
299*4882a593Smuzhiyun return EPOLLOUT | EPOLLWRNORM;
300*4882a593Smuzhiyun }
301*4882a593Smuzhiyun
vhci_open_timeout(struct work_struct * work)302*4882a593Smuzhiyun static void vhci_open_timeout(struct work_struct *work)
303*4882a593Smuzhiyun {
304*4882a593Smuzhiyun struct vhci_data *data = container_of(work, struct vhci_data,
305*4882a593Smuzhiyun open_timeout.work);
306*4882a593Smuzhiyun
307*4882a593Smuzhiyun vhci_create_device(data, amp ? HCI_AMP : HCI_PRIMARY);
308*4882a593Smuzhiyun }
309*4882a593Smuzhiyun
vhci_open(struct inode * inode,struct file * file)310*4882a593Smuzhiyun static int vhci_open(struct inode *inode, struct file *file)
311*4882a593Smuzhiyun {
312*4882a593Smuzhiyun struct vhci_data *data;
313*4882a593Smuzhiyun
314*4882a593Smuzhiyun data = kzalloc(sizeof(struct vhci_data), GFP_KERNEL);
315*4882a593Smuzhiyun if (!data)
316*4882a593Smuzhiyun return -ENOMEM;
317*4882a593Smuzhiyun
318*4882a593Smuzhiyun skb_queue_head_init(&data->readq);
319*4882a593Smuzhiyun init_waitqueue_head(&data->read_wait);
320*4882a593Smuzhiyun
321*4882a593Smuzhiyun mutex_init(&data->open_mutex);
322*4882a593Smuzhiyun INIT_DELAYED_WORK(&data->open_timeout, vhci_open_timeout);
323*4882a593Smuzhiyun
324*4882a593Smuzhiyun file->private_data = data;
325*4882a593Smuzhiyun nonseekable_open(inode, file);
326*4882a593Smuzhiyun
327*4882a593Smuzhiyun schedule_delayed_work(&data->open_timeout, msecs_to_jiffies(1000));
328*4882a593Smuzhiyun
329*4882a593Smuzhiyun return 0;
330*4882a593Smuzhiyun }
331*4882a593Smuzhiyun
vhci_release(struct inode * inode,struct file * file)332*4882a593Smuzhiyun static int vhci_release(struct inode *inode, struct file *file)
333*4882a593Smuzhiyun {
334*4882a593Smuzhiyun struct vhci_data *data = file->private_data;
335*4882a593Smuzhiyun struct hci_dev *hdev;
336*4882a593Smuzhiyun
337*4882a593Smuzhiyun cancel_delayed_work_sync(&data->open_timeout);
338*4882a593Smuzhiyun
339*4882a593Smuzhiyun hdev = data->hdev;
340*4882a593Smuzhiyun
341*4882a593Smuzhiyun if (hdev) {
342*4882a593Smuzhiyun hci_unregister_dev(hdev);
343*4882a593Smuzhiyun hci_free_dev(hdev);
344*4882a593Smuzhiyun }
345*4882a593Smuzhiyun
346*4882a593Smuzhiyun skb_queue_purge(&data->readq);
347*4882a593Smuzhiyun file->private_data = NULL;
348*4882a593Smuzhiyun kfree(data);
349*4882a593Smuzhiyun
350*4882a593Smuzhiyun return 0;
351*4882a593Smuzhiyun }
352*4882a593Smuzhiyun
353*4882a593Smuzhiyun static const struct file_operations vhci_fops = {
354*4882a593Smuzhiyun .owner = THIS_MODULE,
355*4882a593Smuzhiyun .read = vhci_read,
356*4882a593Smuzhiyun .write_iter = vhci_write,
357*4882a593Smuzhiyun .poll = vhci_poll,
358*4882a593Smuzhiyun .open = vhci_open,
359*4882a593Smuzhiyun .release = vhci_release,
360*4882a593Smuzhiyun .llseek = no_llseek,
361*4882a593Smuzhiyun };
362*4882a593Smuzhiyun
363*4882a593Smuzhiyun static struct miscdevice vhci_miscdev = {
364*4882a593Smuzhiyun .name = "vhci",
365*4882a593Smuzhiyun .fops = &vhci_fops,
366*4882a593Smuzhiyun .minor = VHCI_MINOR,
367*4882a593Smuzhiyun };
368*4882a593Smuzhiyun module_misc_device(vhci_miscdev);
369*4882a593Smuzhiyun
370*4882a593Smuzhiyun module_param(amp, bool, 0644);
371*4882a593Smuzhiyun MODULE_PARM_DESC(amp, "Create AMP controller device");
372*4882a593Smuzhiyun
373*4882a593Smuzhiyun MODULE_AUTHOR("Marcel Holtmann <marcel@holtmann.org>");
374*4882a593Smuzhiyun MODULE_DESCRIPTION("Bluetooth virtual HCI driver ver " VERSION);
375*4882a593Smuzhiyun MODULE_VERSION(VERSION);
376*4882a593Smuzhiyun MODULE_LICENSE("GPL");
377*4882a593Smuzhiyun MODULE_ALIAS("devname:vhci");
378*4882a593Smuzhiyun MODULE_ALIAS_MISCDEV(VHCI_MINOR);
379