xref: /OK3568_Linux_fs/kernel/drivers/usb/core/endpoint.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * drivers/usb/core/endpoint.c
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * (C) Copyright 2002,2004,2006 Greg Kroah-Hartman
6*4882a593Smuzhiyun  * (C) Copyright 2002,2004 IBM Corp.
7*4882a593Smuzhiyun  * (C) Copyright 2006 Novell Inc.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * Released under the GPLv2 only.
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * Endpoint sysfs stuff
12*4882a593Smuzhiyun  */
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/kernel.h>
15*4882a593Smuzhiyun #include <linux/spinlock.h>
16*4882a593Smuzhiyun #include <linux/slab.h>
17*4882a593Smuzhiyun #include <linux/usb.h>
18*4882a593Smuzhiyun #include "usb.h"
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun struct ep_device {
21*4882a593Smuzhiyun 	struct usb_endpoint_descriptor *desc;
22*4882a593Smuzhiyun 	struct usb_device *udev;
23*4882a593Smuzhiyun 	struct device dev;
24*4882a593Smuzhiyun };
25*4882a593Smuzhiyun #define to_ep_device(_dev) \
26*4882a593Smuzhiyun 	container_of(_dev, struct ep_device, dev)
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun struct ep_attribute {
29*4882a593Smuzhiyun 	struct attribute attr;
30*4882a593Smuzhiyun 	ssize_t (*show)(struct usb_device *,
31*4882a593Smuzhiyun 			struct usb_endpoint_descriptor *, char *);
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun #define to_ep_attribute(_attr) \
34*4882a593Smuzhiyun 	container_of(_attr, struct ep_attribute, attr)
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun #define usb_ep_attr(field, format_string)			\
37*4882a593Smuzhiyun static ssize_t field##_show(struct device *dev,			\
38*4882a593Smuzhiyun 			       struct device_attribute *attr,	\
39*4882a593Smuzhiyun 			       char *buf)			\
40*4882a593Smuzhiyun {								\
41*4882a593Smuzhiyun 	struct ep_device *ep = to_ep_device(dev);		\
42*4882a593Smuzhiyun 	return sprintf(buf, format_string, ep->desc->field);	\
43*4882a593Smuzhiyun }								\
44*4882a593Smuzhiyun static DEVICE_ATTR_RO(field)
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun usb_ep_attr(bLength, "%02x\n");
47*4882a593Smuzhiyun usb_ep_attr(bEndpointAddress, "%02x\n");
48*4882a593Smuzhiyun usb_ep_attr(bmAttributes, "%02x\n");
49*4882a593Smuzhiyun usb_ep_attr(bInterval, "%02x\n");
50*4882a593Smuzhiyun 
wMaxPacketSize_show(struct device * dev,struct device_attribute * attr,char * buf)51*4882a593Smuzhiyun static ssize_t wMaxPacketSize_show(struct device *dev,
52*4882a593Smuzhiyun 				   struct device_attribute *attr, char *buf)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	struct ep_device *ep = to_ep_device(dev);
55*4882a593Smuzhiyun 	return sprintf(buf, "%04x\n", usb_endpoint_maxp(ep->desc));
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun static DEVICE_ATTR_RO(wMaxPacketSize);
58*4882a593Smuzhiyun 
type_show(struct device * dev,struct device_attribute * attr,char * buf)59*4882a593Smuzhiyun static ssize_t type_show(struct device *dev, struct device_attribute *attr,
60*4882a593Smuzhiyun 			 char *buf)
61*4882a593Smuzhiyun {
62*4882a593Smuzhiyun 	struct ep_device *ep = to_ep_device(dev);
63*4882a593Smuzhiyun 	char *type = "unknown";
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	switch (usb_endpoint_type(ep->desc)) {
66*4882a593Smuzhiyun 	case USB_ENDPOINT_XFER_CONTROL:
67*4882a593Smuzhiyun 		type = "Control";
68*4882a593Smuzhiyun 		break;
69*4882a593Smuzhiyun 	case USB_ENDPOINT_XFER_ISOC:
70*4882a593Smuzhiyun 		type = "Isoc";
71*4882a593Smuzhiyun 		break;
72*4882a593Smuzhiyun 	case USB_ENDPOINT_XFER_BULK:
73*4882a593Smuzhiyun 		type = "Bulk";
74*4882a593Smuzhiyun 		break;
75*4882a593Smuzhiyun 	case USB_ENDPOINT_XFER_INT:
76*4882a593Smuzhiyun 		type = "Interrupt";
77*4882a593Smuzhiyun 		break;
78*4882a593Smuzhiyun 	}
79*4882a593Smuzhiyun 	return sprintf(buf, "%s\n", type);
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun static DEVICE_ATTR_RO(type);
82*4882a593Smuzhiyun 
interval_show(struct device * dev,struct device_attribute * attr,char * buf)83*4882a593Smuzhiyun static ssize_t interval_show(struct device *dev, struct device_attribute *attr,
84*4882a593Smuzhiyun 			     char *buf)
85*4882a593Smuzhiyun {
86*4882a593Smuzhiyun 	struct ep_device *ep = to_ep_device(dev);
87*4882a593Smuzhiyun 	unsigned int interval;
88*4882a593Smuzhiyun 	char unit;
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	interval = usb_decode_interval(ep->desc, ep->udev->speed);
91*4882a593Smuzhiyun 	if (interval % 1000) {
92*4882a593Smuzhiyun 		unit = 'u';
93*4882a593Smuzhiyun 	} else {
94*4882a593Smuzhiyun 		unit = 'm';
95*4882a593Smuzhiyun 		interval /= 1000;
96*4882a593Smuzhiyun 	}
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	return sprintf(buf, "%d%cs\n", interval, unit);
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun static DEVICE_ATTR_RO(interval);
101*4882a593Smuzhiyun 
direction_show(struct device * dev,struct device_attribute * attr,char * buf)102*4882a593Smuzhiyun static ssize_t direction_show(struct device *dev, struct device_attribute *attr,
103*4882a593Smuzhiyun 			      char *buf)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun 	struct ep_device *ep = to_ep_device(dev);
106*4882a593Smuzhiyun 	char *direction;
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	if (usb_endpoint_xfer_control(ep->desc))
109*4882a593Smuzhiyun 		direction = "both";
110*4882a593Smuzhiyun 	else if (usb_endpoint_dir_in(ep->desc))
111*4882a593Smuzhiyun 		direction = "in";
112*4882a593Smuzhiyun 	else
113*4882a593Smuzhiyun 		direction = "out";
114*4882a593Smuzhiyun 	return sprintf(buf, "%s\n", direction);
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun static DEVICE_ATTR_RO(direction);
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun static struct attribute *ep_dev_attrs[] = {
119*4882a593Smuzhiyun 	&dev_attr_bLength.attr,
120*4882a593Smuzhiyun 	&dev_attr_bEndpointAddress.attr,
121*4882a593Smuzhiyun 	&dev_attr_bmAttributes.attr,
122*4882a593Smuzhiyun 	&dev_attr_bInterval.attr,
123*4882a593Smuzhiyun 	&dev_attr_wMaxPacketSize.attr,
124*4882a593Smuzhiyun 	&dev_attr_interval.attr,
125*4882a593Smuzhiyun 	&dev_attr_type.attr,
126*4882a593Smuzhiyun 	&dev_attr_direction.attr,
127*4882a593Smuzhiyun 	NULL,
128*4882a593Smuzhiyun };
129*4882a593Smuzhiyun static struct attribute_group ep_dev_attr_grp = {
130*4882a593Smuzhiyun 	.attrs = ep_dev_attrs,
131*4882a593Smuzhiyun };
132*4882a593Smuzhiyun static const struct attribute_group *ep_dev_groups[] = {
133*4882a593Smuzhiyun 	&ep_dev_attr_grp,
134*4882a593Smuzhiyun 	NULL
135*4882a593Smuzhiyun };
136*4882a593Smuzhiyun 
ep_device_release(struct device * dev)137*4882a593Smuzhiyun static void ep_device_release(struct device *dev)
138*4882a593Smuzhiyun {
139*4882a593Smuzhiyun 	struct ep_device *ep_dev = to_ep_device(dev);
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	kfree(ep_dev);
142*4882a593Smuzhiyun }
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun struct device_type usb_ep_device_type = {
145*4882a593Smuzhiyun 	.name =		"usb_endpoint",
146*4882a593Smuzhiyun 	.release = ep_device_release,
147*4882a593Smuzhiyun };
148*4882a593Smuzhiyun 
usb_create_ep_devs(struct device * parent,struct usb_host_endpoint * endpoint,struct usb_device * udev)149*4882a593Smuzhiyun int usb_create_ep_devs(struct device *parent,
150*4882a593Smuzhiyun 			struct usb_host_endpoint *endpoint,
151*4882a593Smuzhiyun 			struct usb_device *udev)
152*4882a593Smuzhiyun {
153*4882a593Smuzhiyun 	struct ep_device *ep_dev;
154*4882a593Smuzhiyun 	int retval;
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun 	ep_dev = kzalloc(sizeof(*ep_dev), GFP_KERNEL);
157*4882a593Smuzhiyun 	if (!ep_dev) {
158*4882a593Smuzhiyun 		retval = -ENOMEM;
159*4882a593Smuzhiyun 		goto exit;
160*4882a593Smuzhiyun 	}
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 	ep_dev->desc = &endpoint->desc;
163*4882a593Smuzhiyun 	ep_dev->udev = udev;
164*4882a593Smuzhiyun 	ep_dev->dev.groups = ep_dev_groups;
165*4882a593Smuzhiyun 	ep_dev->dev.type = &usb_ep_device_type;
166*4882a593Smuzhiyun 	ep_dev->dev.parent = parent;
167*4882a593Smuzhiyun 	dev_set_name(&ep_dev->dev, "ep_%02x", endpoint->desc.bEndpointAddress);
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 	retval = device_register(&ep_dev->dev);
170*4882a593Smuzhiyun 	if (retval)
171*4882a593Smuzhiyun 		goto error_register;
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun 	device_enable_async_suspend(&ep_dev->dev);
174*4882a593Smuzhiyun 	endpoint->ep_dev = ep_dev;
175*4882a593Smuzhiyun 	return retval;
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun error_register:
178*4882a593Smuzhiyun 	put_device(&ep_dev->dev);
179*4882a593Smuzhiyun exit:
180*4882a593Smuzhiyun 	return retval;
181*4882a593Smuzhiyun }
182*4882a593Smuzhiyun 
usb_remove_ep_devs(struct usb_host_endpoint * endpoint)183*4882a593Smuzhiyun void usb_remove_ep_devs(struct usb_host_endpoint *endpoint)
184*4882a593Smuzhiyun {
185*4882a593Smuzhiyun 	struct ep_device *ep_dev = endpoint->ep_dev;
186*4882a593Smuzhiyun 
187*4882a593Smuzhiyun 	if (ep_dev) {
188*4882a593Smuzhiyun 		device_unregister(&ep_dev->dev);
189*4882a593Smuzhiyun 		endpoint->ep_dev = NULL;
190*4882a593Smuzhiyun 	}
191*4882a593Smuzhiyun }
192