xref: /OK3568_Linux_fs/kernel/drivers/greybus/module.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Greybus Module code
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright 2016 Google Inc.
6*4882a593Smuzhiyun  * Copyright 2016 Linaro Ltd.
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/greybus.h>
10*4882a593Smuzhiyun #include "greybus_trace.h"
11*4882a593Smuzhiyun 
eject_store(struct device * dev,struct device_attribute * attr,const char * buf,size_t len)12*4882a593Smuzhiyun static ssize_t eject_store(struct device *dev,
13*4882a593Smuzhiyun 			   struct device_attribute *attr,
14*4882a593Smuzhiyun 			   const char *buf, size_t len)
15*4882a593Smuzhiyun {
16*4882a593Smuzhiyun 	struct gb_module *module = to_gb_module(dev);
17*4882a593Smuzhiyun 	struct gb_interface *intf;
18*4882a593Smuzhiyun 	size_t i;
19*4882a593Smuzhiyun 	long val;
20*4882a593Smuzhiyun 	int ret;
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun 	ret = kstrtol(buf, 0, &val);
23*4882a593Smuzhiyun 	if (ret)
24*4882a593Smuzhiyun 		return ret;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	if (!val)
27*4882a593Smuzhiyun 		return len;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun 	for (i = 0; i < module->num_interfaces; ++i) {
30*4882a593Smuzhiyun 		intf = module->interfaces[i];
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 		mutex_lock(&intf->mutex);
33*4882a593Smuzhiyun 		/* Set flag to prevent concurrent activation. */
34*4882a593Smuzhiyun 		intf->ejected = true;
35*4882a593Smuzhiyun 		gb_interface_disable(intf);
36*4882a593Smuzhiyun 		gb_interface_deactivate(intf);
37*4882a593Smuzhiyun 		mutex_unlock(&intf->mutex);
38*4882a593Smuzhiyun 	}
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	/* Tell the SVC to eject the primary interface. */
41*4882a593Smuzhiyun 	ret = gb_svc_intf_eject(module->hd->svc, module->module_id);
42*4882a593Smuzhiyun 	if (ret)
43*4882a593Smuzhiyun 		return ret;
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	return len;
46*4882a593Smuzhiyun }
47*4882a593Smuzhiyun static DEVICE_ATTR_WO(eject);
48*4882a593Smuzhiyun 
module_id_show(struct device * dev,struct device_attribute * attr,char * buf)49*4882a593Smuzhiyun static ssize_t module_id_show(struct device *dev,
50*4882a593Smuzhiyun 			      struct device_attribute *attr, char *buf)
51*4882a593Smuzhiyun {
52*4882a593Smuzhiyun 	struct gb_module *module = to_gb_module(dev);
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	return sprintf(buf, "%u\n", module->module_id);
55*4882a593Smuzhiyun }
56*4882a593Smuzhiyun static DEVICE_ATTR_RO(module_id);
57*4882a593Smuzhiyun 
num_interfaces_show(struct device * dev,struct device_attribute * attr,char * buf)58*4882a593Smuzhiyun static ssize_t num_interfaces_show(struct device *dev,
59*4882a593Smuzhiyun 				   struct device_attribute *attr, char *buf)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun 	struct gb_module *module = to_gb_module(dev);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	return sprintf(buf, "%zu\n", module->num_interfaces);
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun static DEVICE_ATTR_RO(num_interfaces);
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun static struct attribute *module_attrs[] = {
68*4882a593Smuzhiyun 	&dev_attr_eject.attr,
69*4882a593Smuzhiyun 	&dev_attr_module_id.attr,
70*4882a593Smuzhiyun 	&dev_attr_num_interfaces.attr,
71*4882a593Smuzhiyun 	NULL,
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun ATTRIBUTE_GROUPS(module);
74*4882a593Smuzhiyun 
gb_module_release(struct device * dev)75*4882a593Smuzhiyun static void gb_module_release(struct device *dev)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun 	struct gb_module *module = to_gb_module(dev);
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun 	trace_gb_module_release(module);
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	kfree(module);
82*4882a593Smuzhiyun }
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun struct device_type greybus_module_type = {
85*4882a593Smuzhiyun 	.name		= "greybus_module",
86*4882a593Smuzhiyun 	.release	= gb_module_release,
87*4882a593Smuzhiyun };
88*4882a593Smuzhiyun 
gb_module_create(struct gb_host_device * hd,u8 module_id,size_t num_interfaces)89*4882a593Smuzhiyun struct gb_module *gb_module_create(struct gb_host_device *hd, u8 module_id,
90*4882a593Smuzhiyun 				   size_t num_interfaces)
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun 	struct gb_interface *intf;
93*4882a593Smuzhiyun 	struct gb_module *module;
94*4882a593Smuzhiyun 	int i;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	module = kzalloc(struct_size(module, interfaces, num_interfaces),
97*4882a593Smuzhiyun 			 GFP_KERNEL);
98*4882a593Smuzhiyun 	if (!module)
99*4882a593Smuzhiyun 		return NULL;
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun 	module->hd = hd;
102*4882a593Smuzhiyun 	module->module_id = module_id;
103*4882a593Smuzhiyun 	module->num_interfaces = num_interfaces;
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	module->dev.parent = &hd->dev;
106*4882a593Smuzhiyun 	module->dev.bus = &greybus_bus_type;
107*4882a593Smuzhiyun 	module->dev.type = &greybus_module_type;
108*4882a593Smuzhiyun 	module->dev.groups = module_groups;
109*4882a593Smuzhiyun 	module->dev.dma_mask = hd->dev.dma_mask;
110*4882a593Smuzhiyun 	device_initialize(&module->dev);
111*4882a593Smuzhiyun 	dev_set_name(&module->dev, "%d-%u", hd->bus_id, module_id);
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun 	trace_gb_module_create(module);
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	for (i = 0; i < num_interfaces; ++i) {
116*4882a593Smuzhiyun 		intf = gb_interface_create(module, module_id + i);
117*4882a593Smuzhiyun 		if (!intf) {
118*4882a593Smuzhiyun 			dev_err(&module->dev, "failed to create interface %u\n",
119*4882a593Smuzhiyun 				module_id + i);
120*4882a593Smuzhiyun 			goto err_put_interfaces;
121*4882a593Smuzhiyun 		}
122*4882a593Smuzhiyun 		module->interfaces[i] = intf;
123*4882a593Smuzhiyun 	}
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	return module;
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun err_put_interfaces:
128*4882a593Smuzhiyun 	for (--i; i >= 0; --i)
129*4882a593Smuzhiyun 		gb_interface_put(module->interfaces[i]);
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun 	put_device(&module->dev);
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	return NULL;
134*4882a593Smuzhiyun }
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun /*
137*4882a593Smuzhiyun  * Register and enable an interface after first attempting to activate it.
138*4882a593Smuzhiyun  */
gb_module_register_interface(struct gb_interface * intf)139*4882a593Smuzhiyun static void gb_module_register_interface(struct gb_interface *intf)
140*4882a593Smuzhiyun {
141*4882a593Smuzhiyun 	struct gb_module *module = intf->module;
142*4882a593Smuzhiyun 	u8 intf_id = intf->interface_id;
143*4882a593Smuzhiyun 	int ret;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	mutex_lock(&intf->mutex);
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	ret = gb_interface_activate(intf);
148*4882a593Smuzhiyun 	if (ret) {
149*4882a593Smuzhiyun 		if (intf->type != GB_INTERFACE_TYPE_DUMMY) {
150*4882a593Smuzhiyun 			dev_err(&module->dev,
151*4882a593Smuzhiyun 				"failed to activate interface %u: %d\n",
152*4882a593Smuzhiyun 				intf_id, ret);
153*4882a593Smuzhiyun 		}
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 		gb_interface_add(intf);
156*4882a593Smuzhiyun 		goto err_unlock;
157*4882a593Smuzhiyun 	}
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	ret = gb_interface_add(intf);
160*4882a593Smuzhiyun 	if (ret)
161*4882a593Smuzhiyun 		goto err_interface_deactivate;
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun 	ret = gb_interface_enable(intf);
164*4882a593Smuzhiyun 	if (ret) {
165*4882a593Smuzhiyun 		dev_err(&module->dev, "failed to enable interface %u: %d\n",
166*4882a593Smuzhiyun 			intf_id, ret);
167*4882a593Smuzhiyun 		goto err_interface_deactivate;
168*4882a593Smuzhiyun 	}
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	mutex_unlock(&intf->mutex);
171*4882a593Smuzhiyun 
172*4882a593Smuzhiyun 	return;
173*4882a593Smuzhiyun 
174*4882a593Smuzhiyun err_interface_deactivate:
175*4882a593Smuzhiyun 	gb_interface_deactivate(intf);
176*4882a593Smuzhiyun err_unlock:
177*4882a593Smuzhiyun 	mutex_unlock(&intf->mutex);
178*4882a593Smuzhiyun }
179*4882a593Smuzhiyun 
gb_module_deregister_interface(struct gb_interface * intf)180*4882a593Smuzhiyun static void gb_module_deregister_interface(struct gb_interface *intf)
181*4882a593Smuzhiyun {
182*4882a593Smuzhiyun 	/* Mark as disconnected to prevent I/O during disable. */
183*4882a593Smuzhiyun 	if (intf->module->disconnected)
184*4882a593Smuzhiyun 		intf->disconnected = true;
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	mutex_lock(&intf->mutex);
187*4882a593Smuzhiyun 	intf->removed = true;
188*4882a593Smuzhiyun 	gb_interface_disable(intf);
189*4882a593Smuzhiyun 	gb_interface_deactivate(intf);
190*4882a593Smuzhiyun 	mutex_unlock(&intf->mutex);
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun 	gb_interface_del(intf);
193*4882a593Smuzhiyun }
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun /* Register a module and its interfaces. */
gb_module_add(struct gb_module * module)196*4882a593Smuzhiyun int gb_module_add(struct gb_module *module)
197*4882a593Smuzhiyun {
198*4882a593Smuzhiyun 	size_t i;
199*4882a593Smuzhiyun 	int ret;
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	ret = device_add(&module->dev);
202*4882a593Smuzhiyun 	if (ret) {
203*4882a593Smuzhiyun 		dev_err(&module->dev, "failed to register module: %d\n", ret);
204*4882a593Smuzhiyun 		return ret;
205*4882a593Smuzhiyun 	}
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun 	trace_gb_module_add(module);
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun 	for (i = 0; i < module->num_interfaces; ++i)
210*4882a593Smuzhiyun 		gb_module_register_interface(module->interfaces[i]);
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	return 0;
213*4882a593Smuzhiyun }
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun /* Deregister a module and its interfaces. */
gb_module_del(struct gb_module * module)216*4882a593Smuzhiyun void gb_module_del(struct gb_module *module)
217*4882a593Smuzhiyun {
218*4882a593Smuzhiyun 	size_t i;
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun 	for (i = 0; i < module->num_interfaces; ++i)
221*4882a593Smuzhiyun 		gb_module_deregister_interface(module->interfaces[i]);
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 	trace_gb_module_del(module);
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 	device_del(&module->dev);
226*4882a593Smuzhiyun }
227*4882a593Smuzhiyun 
gb_module_put(struct gb_module * module)228*4882a593Smuzhiyun void gb_module_put(struct gb_module *module)
229*4882a593Smuzhiyun {
230*4882a593Smuzhiyun 	size_t i;
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 	for (i = 0; i < module->num_interfaces; ++i)
233*4882a593Smuzhiyun 		gb_interface_put(module->interfaces[i]);
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun 	put_device(&module->dev);
236*4882a593Smuzhiyun }
237