blob: fe7bd2850d5d8081b8791fab9f1645b052b058d0 [file] [log] [blame]
Alex Elder30c6d9d2015-05-22 13:02:08 -05001/*
2 * SVC Greybus driver.
3 *
4 * Copyright 2015 Google Inc.
5 * Copyright 2015 Linaro Ltd.
6 *
7 * Released under the GPLv2 only.
8 */
9
Viresh Kumar067906f2015-08-06 12:44:55 +053010#include <linux/workqueue.h>
Alex Elder30c6d9d2015-05-22 13:02:08 -050011
Viresh Kumarf66427a2015-09-02 21:27:13 +053012#include "greybus.h"
13
Johan Hovoldf6c6c132015-11-11 10:07:08 +010014#define CPORT_FLAGS_E2EFC BIT(0)
15#define CPORT_FLAGS_CSD_N BIT(1)
16#define CPORT_FLAGS_CSV_N BIT(2)
Perry Hung0b226492015-07-24 19:02:34 -040017
Viresh Kumarb45864d2015-07-24 15:32:21 +053018
Johan Hovold9ae41092015-12-02 18:23:29 +010019struct gb_svc_deferred_request {
Viresh Kumar067906f2015-08-06 12:44:55 +053020 struct work_struct work;
Johan Hovold9ae41092015-12-02 18:23:29 +010021 struct gb_operation *operation;
Viresh Kumar067906f2015-08-06 12:44:55 +053022};
23
Viresh Kumaread35462015-07-21 17:44:19 +053024
Johan Hovold66069fb2015-11-25 15:59:09 +010025static ssize_t endo_id_show(struct device *dev,
26 struct device_attribute *attr, char *buf)
27{
28 struct gb_svc *svc = to_gb_svc(dev);
29
30 return sprintf(buf, "0x%04x\n", svc->endo_id);
31}
32static DEVICE_ATTR_RO(endo_id);
33
34static ssize_t ap_intf_id_show(struct device *dev,
35 struct device_attribute *attr, char *buf)
36{
37 struct gb_svc *svc = to_gb_svc(dev);
38
39 return sprintf(buf, "%u\n", svc->ap_intf_id);
40}
41static DEVICE_ATTR_RO(ap_intf_id);
42
43static struct attribute *svc_attrs[] = {
44 &dev_attr_endo_id.attr,
45 &dev_attr_ap_intf_id.attr,
46 NULL,
47};
48ATTRIBUTE_GROUPS(svc);
49
Viresh Kumar505f16c2015-08-31 17:21:07 +053050static int gb_svc_intf_device_id(struct gb_svc *svc, u8 intf_id, u8 device_id)
Alex Elder30c6d9d2015-05-22 13:02:08 -050051{
52 struct gb_svc_intf_device_id_request request;
53
54 request.intf_id = intf_id;
55 request.device_id = device_id;
56
57 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_DEVICE_ID,
58 &request, sizeof(request), NULL, 0);
59}
60
Viresh Kumar3f0e9182015-08-31 17:21:06 +053061int gb_svc_intf_reset(struct gb_svc *svc, u8 intf_id)
Alex Elder30c6d9d2015-05-22 13:02:08 -050062{
63 struct gb_svc_intf_reset_request request;
64
65 request.intf_id = intf_id;
66
67 return gb_operation_sync(svc->connection, GB_SVC_TYPE_INTF_RESET,
68 &request, sizeof(request), NULL, 0);
69}
Viresh Kumar3f0e9182015-08-31 17:21:06 +053070EXPORT_SYMBOL_GPL(gb_svc_intf_reset);
Alex Elder30c6d9d2015-05-22 13:02:08 -050071
Viresh Kumar19151c32015-09-09 21:08:29 +053072int gb_svc_dme_peer_get(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
73 u32 *value)
74{
75 struct gb_svc_dme_peer_get_request request;
76 struct gb_svc_dme_peer_get_response response;
77 u16 result;
78 int ret;
79
80 request.intf_id = intf_id;
81 request.attr = cpu_to_le16(attr);
82 request.selector = cpu_to_le16(selector);
83
84 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_GET,
85 &request, sizeof(request),
86 &response, sizeof(response));
87 if (ret) {
Viresh Kumarb933fa42015-12-04 21:30:10 +053088 dev_err(&svc->dev, "failed to get DME attribute (%u 0x%04x %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +010089 intf_id, attr, selector, ret);
Viresh Kumar19151c32015-09-09 21:08:29 +053090 return ret;
91 }
92
93 result = le16_to_cpu(response.result_code);
94 if (result) {
Viresh Kumarb933fa42015-12-04 21:30:10 +053095 dev_err(&svc->dev, "UniPro error while getting DME attribute (%u 0x%04x %u): %u\n",
Johan Hovold684156a2015-11-25 15:59:19 +010096 intf_id, attr, selector, result);
Viresh Kumar4aac6c52015-12-04 21:30:08 +053097 return -EIO;
Viresh Kumar19151c32015-09-09 21:08:29 +053098 }
99
100 if (value)
101 *value = le32_to_cpu(response.attr_value);
102
103 return 0;
104}
105EXPORT_SYMBOL_GPL(gb_svc_dme_peer_get);
106
107int gb_svc_dme_peer_set(struct gb_svc *svc, u8 intf_id, u16 attr, u16 selector,
108 u32 value)
109{
110 struct gb_svc_dme_peer_set_request request;
111 struct gb_svc_dme_peer_set_response response;
112 u16 result;
113 int ret;
114
115 request.intf_id = intf_id;
116 request.attr = cpu_to_le16(attr);
117 request.selector = cpu_to_le16(selector);
118 request.value = cpu_to_le32(value);
119
120 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_DME_PEER_SET,
121 &request, sizeof(request),
122 &response, sizeof(response));
123 if (ret) {
Viresh Kumarb933fa42015-12-04 21:30:10 +0530124 dev_err(&svc->dev, "failed to set DME attribute (%u 0x%04x %u %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100125 intf_id, attr, selector, value, ret);
Viresh Kumar19151c32015-09-09 21:08:29 +0530126 return ret;
127 }
128
129 result = le16_to_cpu(response.result_code);
130 if (result) {
Viresh Kumarb933fa42015-12-04 21:30:10 +0530131 dev_err(&svc->dev, "UniPro error while setting DME attribute (%u 0x%04x %u %u): %u\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100132 intf_id, attr, selector, value, result);
Viresh Kumar4aac6c52015-12-04 21:30:08 +0530133 return -EIO;
Viresh Kumar19151c32015-09-09 21:08:29 +0530134 }
135
136 return 0;
137}
138EXPORT_SYMBOL_GPL(gb_svc_dme_peer_set);
139
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700140/*
141 * T_TstSrcIncrement is written by the module on ES2 as a stand-in for boot
Eli Sennesh3563ff82015-12-22 17:26:57 -0500142 * status attribute ES3_INIT_STATUS. AP needs to read and clear it, after
143 * reading a non-zero value from it.
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700144 *
145 * FIXME: This is module-hardware dependent and needs to be extended for every
146 * type of module we want to support.
147 */
148static int gb_svc_read_and_clear_module_boot_status(struct gb_interface *intf)
149{
Johan Hovold25376362015-11-03 18:03:23 +0100150 struct gb_host_device *hd = intf->hd;
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700151 int ret;
152 u32 value;
Eli Sennesh3563ff82015-12-22 17:26:57 -0500153 u16 attr;
154 u8 init_status;
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700155
Eli Sennesh3563ff82015-12-22 17:26:57 -0500156 /*
157 * Check if the module is ES2 or ES3, and choose attr number
158 * appropriately.
159 * FIXME: Remove ES2 support from the kernel entirely.
160 */
161 if (intf->ddbl1_manufacturer_id == ES2_DDBL1_MFR_ID &&
162 intf->ddbl1_product_id == ES2_DDBL1_PROD_ID)
163 attr = DME_ATTR_T_TST_SRC_INCREMENT;
164 else
165 attr = DME_ATTR_ES3_INIT_STATUS;
166
167 /* Read and clear boot status in ES3_INIT_STATUS */
168 ret = gb_svc_dme_peer_get(hd->svc, intf->interface_id, attr,
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700169 DME_ATTR_SELECTOR_INDEX, &value);
170
171 if (ret)
172 return ret;
173
174 /*
175 * A nonzero boot status indicates the module has finished
176 * booting. Clear it.
177 */
178 if (!value) {
179 dev_err(&intf->dev, "Module not ready yet\n");
180 return -ENODEV;
181 }
182
Viresh Kumar1575ef12015-10-07 15:40:24 -0400183 /*
Eli Sennesh3563ff82015-12-22 17:26:57 -0500184 * Check if the module needs to boot from UniPro.
Viresh Kumar1575ef12015-10-07 15:40:24 -0400185 * For ES2: We need to check lowest 8 bits of 'value'.
186 * For ES3: We need to check highest 8 bits out of 32 of 'value'.
Eli Sennesh3563ff82015-12-22 17:26:57 -0500187 * FIXME: Remove ES2 support from the kernel entirely.
Viresh Kumar1575ef12015-10-07 15:40:24 -0400188 */
Eli Sennesh3563ff82015-12-22 17:26:57 -0500189 if (intf->ddbl1_manufacturer_id == ES2_DDBL1_MFR_ID &&
190 intf->ddbl1_product_id == ES2_DDBL1_PROD_ID)
191 init_status = value;
192 else
193 init_status = value >> 24;
194
195 if (init_status == DME_DIS_UNIPRO_BOOT_STARTED ||
196 init_status == DME_DIS_FALLBACK_UNIPRO_BOOT_STARTED)
Viresh Kumar1575ef12015-10-07 15:40:24 -0400197 intf->boot_over_unipro = true;
198
Eli Sennesh3563ff82015-12-22 17:26:57 -0500199 return gb_svc_dme_peer_set(hd->svc, intf->interface_id, attr,
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700200 DME_ATTR_SELECTOR_INDEX, 0);
201}
202
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530203int gb_svc_connection_create(struct gb_svc *svc,
Alex Elder30c6d9d2015-05-22 13:02:08 -0500204 u8 intf1_id, u16 cport1_id,
Viresh Kumar1575ef12015-10-07 15:40:24 -0400205 u8 intf2_id, u16 cport2_id,
206 bool boot_over_unipro)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500207{
208 struct gb_svc_conn_create_request request;
209
210 request.intf1_id = intf1_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100211 request.cport1_id = cpu_to_le16(cport1_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500212 request.intf2_id = intf2_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100213 request.cport2_id = cpu_to_le16(cport2_id);
Perry Hung0b226492015-07-24 19:02:34 -0400214 /*
215 * XXX: fix connections paramaters to TC0 and all CPort flags
216 * for now.
217 */
218 request.tc = 0;
Viresh Kumar1575ef12015-10-07 15:40:24 -0400219
220 /*
221 * We need to skip setting E2EFC and other flags to the connection
222 * create request, for all cports, on an interface that need to boot
223 * over unipro, i.e. interfaces required to download firmware.
224 */
225 if (boot_over_unipro)
226 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_CSD_N;
227 else
228 request.flags = CPORT_FLAGS_CSV_N | CPORT_FLAGS_E2EFC;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500229
230 return gb_operation_sync(svc->connection, GB_SVC_TYPE_CONN_CREATE,
231 &request, sizeof(request), NULL, 0);
232}
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530233EXPORT_SYMBOL_GPL(gb_svc_connection_create);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500234
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530235void gb_svc_connection_destroy(struct gb_svc *svc, u8 intf1_id, u16 cport1_id,
236 u8 intf2_id, u16 cport2_id)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500237{
238 struct gb_svc_conn_destroy_request request;
Viresh Kumard9fcfff2015-08-31 17:21:05 +0530239 struct gb_connection *connection = svc->connection;
240 int ret;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500241
242 request.intf1_id = intf1_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100243 request.cport1_id = cpu_to_le16(cport1_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500244 request.intf2_id = intf2_id;
Rui Miguel Silva24980502015-09-15 15:33:51 +0100245 request.cport2_id = cpu_to_le16(cport2_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500246
Viresh Kumard9fcfff2015-08-31 17:21:05 +0530247 ret = gb_operation_sync(connection, GB_SVC_TYPE_CONN_DESTROY,
248 &request, sizeof(request), NULL, 0);
Johan Hovold684156a2015-11-25 15:59:19 +0100249 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530250 dev_err(&svc->dev, "failed to destroy connection (%u:%u %u:%u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100251 intf1_id, cport1_id, intf2_id, cport2_id, ret);
252 }
Alex Elder30c6d9d2015-05-22 13:02:08 -0500253}
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530254EXPORT_SYMBOL_GPL(gb_svc_connection_destroy);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500255
Viresh Kumarbb106852015-09-07 16:01:25 +0530256/* Creates bi-directional routes between the devices */
Viresh Kumar505f16c2015-08-31 17:21:07 +0530257static int gb_svc_route_create(struct gb_svc *svc, u8 intf1_id, u8 dev1_id,
258 u8 intf2_id, u8 dev2_id)
Perry Hunge08aaa42015-07-24 19:02:31 -0400259{
260 struct gb_svc_route_create_request request;
261
262 request.intf1_id = intf1_id;
263 request.dev1_id = dev1_id;
264 request.intf2_id = intf2_id;
265 request.dev2_id = dev2_id;
266
267 return gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_CREATE,
268 &request, sizeof(request), NULL, 0);
269}
Perry Hunge08aaa42015-07-24 19:02:31 -0400270
Viresh Kumar0a020572015-09-07 18:05:26 +0530271/* Destroys bi-directional routes between the devices */
272static void gb_svc_route_destroy(struct gb_svc *svc, u8 intf1_id, u8 intf2_id)
273{
274 struct gb_svc_route_destroy_request request;
275 int ret;
276
277 request.intf1_id = intf1_id;
278 request.intf2_id = intf2_id;
279
280 ret = gb_operation_sync(svc->connection, GB_SVC_TYPE_ROUTE_DESTROY,
281 &request, sizeof(request), NULL, 0);
Johan Hovold684156a2015-11-25 15:59:19 +0100282 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530283 dev_err(&svc->dev, "failed to destroy route (%u %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100284 intf1_id, intf2_id, ret);
285 }
Viresh Kumar0a020572015-09-07 18:05:26 +0530286}
287
Laurent Pinchart784f8762015-12-18 21:23:22 +0200288int gb_svc_link_config(struct gb_svc *svc, u8 intf_id,
289 unsigned int burst, unsigned int gear,
290 unsigned int nlanes, unsigned int flags)
291{
292 struct gb_svc_link_config_request request;
293
294 request.intf_id = intf_id;
295 request.burst = burst;
296 request.gear = gear;
297 request.nlanes = nlanes;
298 request.flags = flags;
299
300 return gb_operation_sync(svc->connection, GB_SVC_TYPE_LINK_CONFIG,
301 &request, sizeof(request), NULL, 0);
302}
303EXPORT_SYMBOL_GPL(gb_svc_link_config);
304
Viresh Kumaread35462015-07-21 17:44:19 +0530305static int gb_svc_version_request(struct gb_operation *op)
306{
307 struct gb_connection *connection = op->connection;
Johan Hovold684156a2015-11-25 15:59:19 +0100308 struct gb_svc *svc = connection->private;
Johan Hovoldcfb16902015-09-15 10:48:01 +0200309 struct gb_protocol_version_request *request;
310 struct gb_protocol_version_response *response;
Viresh Kumaread35462015-07-21 17:44:19 +0530311
Johan Hovold55510842015-11-19 18:28:01 +0100312 if (op->request->payload_size < sizeof(*request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100313 dev_err(&svc->dev, "short version request (%zu < %zu)\n",
Johan Hovold55510842015-11-19 18:28:01 +0100314 op->request->payload_size,
315 sizeof(*request));
316 return -EINVAL;
317 }
318
Johan Hovoldcfb16902015-09-15 10:48:01 +0200319 request = op->request->payload;
Viresh Kumaread35462015-07-21 17:44:19 +0530320
Johan Hovoldcfb16902015-09-15 10:48:01 +0200321 if (request->major > GB_SVC_VERSION_MAJOR) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530322 dev_warn(&svc->dev, "unsupported major version (%u > %u)\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100323 request->major, GB_SVC_VERSION_MAJOR);
Viresh Kumaread35462015-07-21 17:44:19 +0530324 return -ENOTSUPP;
325 }
326
Johan Hovoldcfb16902015-09-15 10:48:01 +0200327 connection->module_major = request->major;
328 connection->module_minor = request->minor;
Viresh Kumar3ea959e32015-08-11 07:36:14 +0530329
Johan Hovold684156a2015-11-25 15:59:19 +0100330 if (!gb_operation_response_alloc(op, sizeof(*response), GFP_KERNEL))
Viresh Kumaread35462015-07-21 17:44:19 +0530331 return -ENOMEM;
Viresh Kumaread35462015-07-21 17:44:19 +0530332
Johan Hovoldcfb16902015-09-15 10:48:01 +0200333 response = op->response->payload;
334 response->major = connection->module_major;
335 response->minor = connection->module_minor;
Johan Hovold59832932015-09-15 10:48:00 +0200336
Viresh Kumaread35462015-07-21 17:44:19 +0530337 return 0;
338}
339
340static int gb_svc_hello(struct gb_operation *op)
341{
342 struct gb_connection *connection = op->connection;
Johan Hovold88f7b962015-11-25 15:59:08 +0100343 struct gb_svc *svc = connection->private;
Viresh Kumaread35462015-07-21 17:44:19 +0530344 struct gb_svc_hello_request *hello_request;
Viresh Kumaread35462015-07-21 17:44:19 +0530345 int ret;
346
Viresh Kumar0c32d2a2015-08-11 07:29:19 +0530347 if (op->request->payload_size < sizeof(*hello_request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100348 dev_warn(&svc->dev, "short hello request (%zu < %zu)\n",
349 op->request->payload_size,
350 sizeof(*hello_request));
Viresh Kumaread35462015-07-21 17:44:19 +0530351 return -EINVAL;
352 }
353
354 hello_request = op->request->payload;
Johan Hovold66069fb2015-11-25 15:59:09 +0100355 svc->endo_id = le16_to_cpu(hello_request->endo_id);
356 svc->ap_intf_id = hello_request->interface_id;
Viresh Kumaread35462015-07-21 17:44:19 +0530357
Johan Hovold88f7b962015-11-25 15:59:08 +0100358 ret = device_add(&svc->dev);
359 if (ret) {
360 dev_err(&svc->dev, "failed to register svc device: %d\n", ret);
361 return ret;
362 }
363
Viresh Kumaread35462015-07-21 17:44:19 +0530364 return 0;
365}
366
Johan Hovoldb4ee82e2015-12-02 18:23:28 +0100367static void gb_svc_intf_remove(struct gb_svc *svc, struct gb_interface *intf)
Viresh Kumarbbaca712015-09-23 16:48:08 -0700368{
Viresh Kumarbbaca712015-09-23 16:48:08 -0700369 u8 intf_id = intf->interface_id;
Johan Hovold141af4f2015-12-15 15:28:57 +0100370 u8 device_id = intf->device_id;
Viresh Kumarbbaca712015-09-23 16:48:08 -0700371
Johan Hovold141af4f2015-12-15 15:28:57 +0100372 intf->disconnected = true;
373
Viresh Kumar80d1ede2015-09-23 16:48:10 -0700374 gb_interface_remove(intf);
Viresh Kumarbbaca712015-09-23 16:48:08 -0700375
376 /*
377 * Destroy the two-way route between the AP and the interface.
378 */
Johan Hovold66069fb2015-11-25 15:59:09 +0100379 gb_svc_route_destroy(svc, svc->ap_intf_id, intf_id);
Viresh Kumarbbaca712015-09-23 16:48:08 -0700380
381 ida_simple_remove(&svc->device_id_map, device_id);
382}
383
Johan Hovold9ae41092015-12-02 18:23:29 +0100384static void gb_svc_process_intf_hotplug(struct gb_operation *operation)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500385{
Johan Hovold24456a092015-12-02 18:23:27 +0100386 struct gb_svc_intf_hotplug_request *request;
Johan Hovold9ae41092015-12-02 18:23:29 +0100387 struct gb_connection *connection = operation->connection;
Viresh Kumar067906f2015-08-06 12:44:55 +0530388 struct gb_svc *svc = connection->private;
Johan Hovold25376362015-11-03 18:03:23 +0100389 struct gb_host_device *hd = connection->hd;
Viresh Kumaread35462015-07-21 17:44:19 +0530390 struct gb_interface *intf;
391 u8 intf_id, device_id;
Viresh Kumaread35462015-07-21 17:44:19 +0530392 int ret;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500393
Johan Hovold24456a092015-12-02 18:23:27 +0100394 /* The request message size has already been verified. */
Johan Hovold9ae41092015-12-02 18:23:29 +0100395 request = operation->request->payload;
Johan Hovold24456a092015-12-02 18:23:27 +0100396 intf_id = request->intf_id;
397
398 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, intf_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500399
Viresh Kumarbbaca712015-09-23 16:48:08 -0700400 intf = gb_interface_find(hd, intf_id);
401 if (intf) {
402 /*
403 * We have received a hotplug request for an interface that
404 * already exists.
405 *
406 * This can happen in cases like:
407 * - bootrom loading the firmware image and booting into that,
408 * which only generates a hotplug event. i.e. no hot-unplug
409 * event.
410 * - Or the firmware on the module crashed and sent hotplug
411 * request again to the SVC, which got propagated to AP.
412 *
413 * Remove the interface and add it again, and let user know
414 * about this with a print message.
415 */
Viresh Kumar2f3db922015-12-04 21:30:09 +0530416 dev_info(&svc->dev, "removing interface %u to add it again\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100417 intf_id);
Johan Hovoldb4ee82e2015-12-02 18:23:28 +0100418 gb_svc_intf_remove(svc, intf);
Viresh Kumarbbaca712015-09-23 16:48:08 -0700419 }
420
Viresh Kumaread35462015-07-21 17:44:19 +0530421 intf = gb_interface_create(hd, intf_id);
422 if (!intf) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530423 dev_err(&svc->dev, "failed to create interface %u\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100424 intf_id);
Johan Hovold9ae41092015-12-02 18:23:29 +0100425 return;
Viresh Kumaread35462015-07-21 17:44:19 +0530426 }
427
Viresh Kumar63d742b2015-12-23 09:07:42 +0530428 intf->ddbl1_manufacturer_id = le32_to_cpu(request->data.ddbl1_mfr_id);
429 intf->ddbl1_product_id = le32_to_cpu(request->data.ddbl1_prod_id);
430 intf->vendor_id = le32_to_cpu(request->data.ara_vend_id);
431 intf->product_id = le32_to_cpu(request->data.ara_prod_id);
Viresh Kumar57c6bcc2015-12-28 11:59:00 +0530432 intf->serial_number = le64_to_cpu(request->data.serial_number);
Viresh Kumar63d742b2015-12-23 09:07:42 +0530433
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700434 ret = gb_svc_read_and_clear_module_boot_status(intf);
Johan Hovoldb395754a2015-12-07 15:05:28 +0100435 if (ret) {
436 dev_err(&svc->dev, "failed to clear boot status of interface %u: %d\n",
437 intf_id, ret);
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700438 goto destroy_interface;
Johan Hovoldb395754a2015-12-07 15:05:28 +0100439 }
Viresh Kumar6bec5c72015-09-24 14:40:29 -0700440
Viresh Kumaread35462015-07-21 17:44:19 +0530441 /*
442 * Create a device id for the interface:
443 * - device id 0 (GB_DEVICE_ID_SVC) belongs to the SVC
444 * - device id 1 (GB_DEVICE_ID_AP) belongs to the AP
445 *
446 * XXX Do we need to allocate device ID for SVC or the AP here? And what
447 * XXX about an AP with multiple interface blocks?
448 */
Johan Hovoldc09db182015-09-15 09:18:08 +0200449 device_id = ida_simple_get(&svc->device_id_map,
Johan Hovold89f637f2015-09-01 12:25:25 +0200450 GB_DEVICE_ID_MODULES_START, 0, GFP_KERNEL);
Viresh Kumaread35462015-07-21 17:44:19 +0530451 if (device_id < 0) {
452 ret = device_id;
Viresh Kumar2f3db922015-12-04 21:30:09 +0530453 dev_err(&svc->dev, "failed to allocate device id for interface %u: %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100454 intf_id, ret);
Viresh Kumaread35462015-07-21 17:44:19 +0530455 goto destroy_interface;
456 }
457
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530458 ret = gb_svc_intf_device_id(svc, intf_id, device_id);
Viresh Kumaread35462015-07-21 17:44:19 +0530459 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530460 dev_err(&svc->dev, "failed to set device id %u for interface %u: %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100461 device_id, intf_id, ret);
Viresh Kumaread35462015-07-21 17:44:19 +0530462 goto ida_put;
463 }
464
Perry Hung7e275462015-07-24 19:02:32 -0400465 /*
466 * Create a two-way route between the AP and the new interface
467 */
Johan Hovold66069fb2015-11-25 15:59:09 +0100468 ret = gb_svc_route_create(svc, svc->ap_intf_id, GB_DEVICE_ID_AP,
Viresh Kumar3f0e9182015-08-31 17:21:06 +0530469 intf_id, device_id);
Perry Hung7e275462015-07-24 19:02:32 -0400470 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530471 dev_err(&svc->dev, "failed to create route to interface %u (device id %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100472 intf_id, device_id, ret);
Viresh Kumar0a020572015-09-07 18:05:26 +0530473 goto svc_id_free;
Perry Hung7e275462015-07-24 19:02:32 -0400474 }
475
Viresh Kumaread35462015-07-21 17:44:19 +0530476 ret = gb_interface_init(intf, device_id);
477 if (ret) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530478 dev_err(&svc->dev, "failed to initialize interface %u (device id %u): %d\n",
Johan Hovold684156a2015-11-25 15:59:19 +0100479 intf_id, device_id, ret);
Viresh Kumar0a020572015-09-07 18:05:26 +0530480 goto destroy_route;
Viresh Kumaread35462015-07-21 17:44:19 +0530481 }
Alex Elder30c6d9d2015-05-22 13:02:08 -0500482
Johan Hovold9ae41092015-12-02 18:23:29 +0100483 return;
Viresh Kumaread35462015-07-21 17:44:19 +0530484
Viresh Kumar0a020572015-09-07 18:05:26 +0530485destroy_route:
Johan Hovold66069fb2015-11-25 15:59:09 +0100486 gb_svc_route_destroy(svc, svc->ap_intf_id, intf_id);
Viresh Kumaread35462015-07-21 17:44:19 +0530487svc_id_free:
488 /*
489 * XXX Should we tell SVC that this id doesn't belong to interface
490 * XXX anymore.
491 */
492ida_put:
Johan Hovoldc09db182015-09-15 09:18:08 +0200493 ida_simple_remove(&svc->device_id_map, device_id);
Viresh Kumaread35462015-07-21 17:44:19 +0530494destroy_interface:
Viresh Kumar80d1ede2015-09-23 16:48:10 -0700495 gb_interface_remove(intf);
Johan Hovold9ae41092015-12-02 18:23:29 +0100496}
497
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100498static void gb_svc_process_intf_hot_unplug(struct gb_operation *operation)
499{
500 struct gb_svc *svc = operation->connection->private;
501 struct gb_svc_intf_hot_unplug_request *request;
502 struct gb_host_device *hd = operation->connection->hd;
503 struct gb_interface *intf;
504 u8 intf_id;
505
506 /* The request message size has already been verified. */
507 request = operation->request->payload;
508 intf_id = request->intf_id;
509
510 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, intf_id);
511
512 intf = gb_interface_find(hd, intf_id);
513 if (!intf) {
Viresh Kumar2f3db922015-12-04 21:30:09 +0530514 dev_warn(&svc->dev, "could not find hot-unplug interface %u\n",
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100515 intf_id);
516 return;
517 }
518
519 gb_svc_intf_remove(svc, intf);
520}
521
Johan Hovold9ae41092015-12-02 18:23:29 +0100522static void gb_svc_process_deferred_request(struct work_struct *work)
523{
524 struct gb_svc_deferred_request *dr;
525 struct gb_operation *operation;
526 struct gb_svc *svc;
527 u8 type;
528
529 dr = container_of(work, struct gb_svc_deferred_request, work);
530 operation = dr->operation;
531 svc = operation->connection->private;
532 type = operation->request->header->type;
533
534 switch (type) {
535 case GB_SVC_TYPE_INTF_HOTPLUG:
536 gb_svc_process_intf_hotplug(operation);
537 break;
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100538 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
539 gb_svc_process_intf_hot_unplug(operation);
540 break;
Johan Hovold9ae41092015-12-02 18:23:29 +0100541 default:
Viresh Kumarb933fa42015-12-04 21:30:10 +0530542 dev_err(&svc->dev, "bad deferred request type: 0x%02x\n", type);
Johan Hovold9ae41092015-12-02 18:23:29 +0100543 }
544
545 gb_operation_put(operation);
546 kfree(dr);
547}
548
549static int gb_svc_queue_deferred_request(struct gb_operation *operation)
550{
Johan Hovold3e48aca2015-12-02 18:23:31 +0100551 struct gb_svc *svc = operation->connection->private;
Johan Hovold9ae41092015-12-02 18:23:29 +0100552 struct gb_svc_deferred_request *dr;
553
554 dr = kmalloc(sizeof(*dr), GFP_KERNEL);
555 if (!dr)
556 return -ENOMEM;
557
558 gb_operation_get(operation);
559
560 dr->operation = operation;
561 INIT_WORK(&dr->work, gb_svc_process_deferred_request);
562
Johan Hovold3e48aca2015-12-02 18:23:31 +0100563 queue_work(svc->wq, &dr->work);
Johan Hovold9ae41092015-12-02 18:23:29 +0100564
565 return 0;
Viresh Kumar067906f2015-08-06 12:44:55 +0530566}
Viresh Kumaread35462015-07-21 17:44:19 +0530567
Viresh Kumar067906f2015-08-06 12:44:55 +0530568/*
569 * Bringing up a module can be time consuming, as that may require lots of
570 * initialization on the module side. Over that, we may also need to download
571 * the firmware first and flash that on the module.
572 *
Johan Hovold3e48aca2015-12-02 18:23:31 +0100573 * In order not to make other svc events wait for all this to finish,
Viresh Kumar067906f2015-08-06 12:44:55 +0530574 * handle most of module hotplug stuff outside of the hotplug callback, with
575 * help of a workqueue.
576 */
577static int gb_svc_intf_hotplug_recv(struct gb_operation *op)
578{
Johan Hovold684156a2015-11-25 15:59:19 +0100579 struct gb_svc *svc = op->connection->private;
Johan Hovoldd34a3642015-12-02 18:23:26 +0100580 struct gb_svc_intf_hotplug_request *request;
Viresh Kumar067906f2015-08-06 12:44:55 +0530581
Johan Hovoldd34a3642015-12-02 18:23:26 +0100582 if (op->request->payload_size < sizeof(*request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100583 dev_warn(&svc->dev, "short hotplug request received (%zu < %zu)\n",
Johan Hovoldd34a3642015-12-02 18:23:26 +0100584 op->request->payload_size, sizeof(*request));
Viresh Kumar067906f2015-08-06 12:44:55 +0530585 return -EINVAL;
586 }
587
Johan Hovoldd34a3642015-12-02 18:23:26 +0100588 request = op->request->payload;
589
590 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, request->intf_id);
591
Johan Hovold9ae41092015-12-02 18:23:29 +0100592 return gb_svc_queue_deferred_request(op);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500593}
594
595static int gb_svc_intf_hot_unplug_recv(struct gb_operation *op)
596{
Johan Hovold684156a2015-11-25 15:59:19 +0100597 struct gb_svc *svc = op->connection->private;
Johan Hovoldd34a3642015-12-02 18:23:26 +0100598 struct gb_svc_intf_hot_unplug_request *request;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500599
Johan Hovoldd34a3642015-12-02 18:23:26 +0100600 if (op->request->payload_size < sizeof(*request)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100601 dev_warn(&svc->dev, "short hot unplug request received (%zu < %zu)\n",
Johan Hovoldd34a3642015-12-02 18:23:26 +0100602 op->request->payload_size, sizeof(*request));
Alex Elder30c6d9d2015-05-22 13:02:08 -0500603 return -EINVAL;
604 }
Alex Elder30c6d9d2015-05-22 13:02:08 -0500605
Johan Hovoldd34a3642015-12-02 18:23:26 +0100606 request = op->request->payload;
Johan Hovoldd34a3642015-12-02 18:23:26 +0100607
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100608 dev_dbg(&svc->dev, "%s - id = %u\n", __func__, request->intf_id);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500609
Johan Hovold57ccd4b2015-12-02 18:23:30 +0100610 return gb_svc_queue_deferred_request(op);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500611}
612
613static int gb_svc_intf_reset_recv(struct gb_operation *op)
614{
Johan Hovold684156a2015-11-25 15:59:19 +0100615 struct gb_svc *svc = op->connection->private;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500616 struct gb_message *request = op->request;
617 struct gb_svc_intf_reset_request *reset;
618 u8 intf_id;
619
620 if (request->payload_size < sizeof(*reset)) {
Johan Hovold684156a2015-11-25 15:59:19 +0100621 dev_warn(&svc->dev, "short reset request received (%zu < %zu)\n",
622 request->payload_size, sizeof(*reset));
Alex Elder30c6d9d2015-05-22 13:02:08 -0500623 return -EINVAL;
624 }
625 reset = request->payload;
626
627 intf_id = reset->intf_id;
628
629 /* FIXME Reset the interface here */
630
631 return 0;
632}
633
634static int gb_svc_request_recv(u8 type, struct gb_operation *op)
635{
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530636 struct gb_connection *connection = op->connection;
637 struct gb_svc *svc = connection->private;
638 int ret = 0;
639
640 /*
641 * SVC requests need to follow a specific order (at least initially) and
642 * below code takes care of enforcing that. The expected order is:
643 * - PROTOCOL_VERSION
644 * - SVC_HELLO
645 * - Any other request, but the earlier two.
646 *
647 * Incoming requests are guaranteed to be serialized and so we don't
648 * need to protect 'state' for any races.
649 */
Alex Elder30c6d9d2015-05-22 13:02:08 -0500650 switch (type) {
Viresh Kumar0e2462d2015-08-14 07:57:38 +0530651 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530652 if (svc->state != GB_SVC_STATE_RESET)
653 ret = -EINVAL;
654 break;
Viresh Kumaread35462015-07-21 17:44:19 +0530655 case GB_SVC_TYPE_SVC_HELLO:
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530656 if (svc->state != GB_SVC_STATE_PROTOCOL_VERSION)
657 ret = -EINVAL;
658 break;
659 default:
660 if (svc->state != GB_SVC_STATE_SVC_HELLO)
661 ret = -EINVAL;
662 break;
663 }
664
665 if (ret) {
Johan Hovold684156a2015-11-25 15:59:19 +0100666 dev_warn(&svc->dev, "unexpected request 0x%02x received (state %u)\n",
667 type, svc->state);
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530668 return ret;
669 }
670
671 switch (type) {
672 case GB_REQUEST_TYPE_PROTOCOL_VERSION:
673 ret = gb_svc_version_request(op);
674 if (!ret)
675 svc->state = GB_SVC_STATE_PROTOCOL_VERSION;
676 return ret;
677 case GB_SVC_TYPE_SVC_HELLO:
678 ret = gb_svc_hello(op);
679 if (!ret)
680 svc->state = GB_SVC_STATE_SVC_HELLO;
681 return ret;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500682 case GB_SVC_TYPE_INTF_HOTPLUG:
683 return gb_svc_intf_hotplug_recv(op);
684 case GB_SVC_TYPE_INTF_HOT_UNPLUG:
685 return gb_svc_intf_hot_unplug_recv(op);
686 case GB_SVC_TYPE_INTF_RESET:
687 return gb_svc_intf_reset_recv(op);
688 default:
Johan Hovold684156a2015-11-25 15:59:19 +0100689 dev_warn(&svc->dev, "unsupported request 0x%02x\n", type);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500690 return -EINVAL;
691 }
692}
693
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100694static void gb_svc_release(struct device *dev)
695{
Johan Hovold88f7b962015-11-25 15:59:08 +0100696 struct gb_svc *svc = to_gb_svc(dev);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100697
Johan Hovold7adeaae72015-12-07 15:05:37 +0100698 if (svc->connection)
699 gb_connection_destroy(svc->connection);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100700 ida_destroy(&svc->device_id_map);
Johan Hovold3e48aca2015-12-02 18:23:31 +0100701 destroy_workqueue(svc->wq);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100702 kfree(svc);
703}
704
705struct device_type greybus_svc_type = {
706 .name = "greybus_svc",
707 .release = gb_svc_release,
708};
709
Johan Hovold7adeaae72015-12-07 15:05:37 +0100710struct gb_svc *gb_svc_create(struct gb_host_device *hd)
Alex Elder30c6d9d2015-05-22 13:02:08 -0500711{
712 struct gb_svc *svc;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500713
714 svc = kzalloc(sizeof(*svc), GFP_KERNEL);
715 if (!svc)
Johan Hovold7adeaae72015-12-07 15:05:37 +0100716 return NULL;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500717
Johan Hovold3e48aca2015-12-02 18:23:31 +0100718 svc->wq = alloc_workqueue("%s:svc", WQ_UNBOUND, 1, dev_name(&hd->dev));
719 if (!svc->wq) {
720 kfree(svc);
Johan Hovold7adeaae72015-12-07 15:05:37 +0100721 return NULL;
Johan Hovold3e48aca2015-12-02 18:23:31 +0100722 }
723
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100724 svc->dev.parent = &hd->dev;
725 svc->dev.bus = &greybus_bus_type;
726 svc->dev.type = &greybus_svc_type;
Johan Hovold66069fb2015-11-25 15:59:09 +0100727 svc->dev.groups = svc_groups;
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100728 svc->dev.dma_mask = svc->dev.parent->dma_mask;
729 device_initialize(&svc->dev);
730
731 dev_set_name(&svc->dev, "%d-svc", hd->bus_id);
732
Johan Hovold6106e512015-11-25 15:59:07 +0100733 ida_init(&svc->device_id_map);
Viresh Kumar3ccb1602015-09-03 15:42:22 +0530734 svc->state = GB_SVC_STATE_RESET;
Johan Hovoldf0960d02015-12-03 19:18:02 +0100735 svc->hd = hd;
Viresh Kumard3d44842015-07-21 17:44:18 +0530736
Johan Hovold7adeaae72015-12-07 15:05:37 +0100737 svc->connection = gb_connection_create_static(hd, GB_SVC_CPORT_ID,
738 GREYBUS_PROTOCOL_SVC);
739 if (!svc->connection) {
740 dev_err(&svc->dev, "failed to create connection\n");
741 put_device(&svc->dev);
742 return NULL;
743 }
744
745 svc->connection->private = svc;
746
747 return svc;
748}
749
750int gb_svc_add(struct gb_svc *svc)
751{
752 int ret;
753
754 /*
755 * The SVC protocol is currently driven by the SVC, so the SVC device
756 * is added from the connection request handler when enough
757 * information has been received.
758 */
759 ret = gb_connection_init(svc->connection);
760 if (ret)
761 return ret;
762
763 return 0;
764}
765
766void gb_svc_del(struct gb_svc *svc)
767{
768 /*
769 * The SVC device may have been registered from the request handler.
770 */
771 if (device_is_registered(&svc->dev))
772 device_del(&svc->dev);
773
774 gb_connection_exit(svc->connection);
775
776 flush_workqueue(svc->wq);
777}
778
779void gb_svc_put(struct gb_svc *svc)
780{
781 put_device(&svc->dev);
782}
783
784static int gb_svc_connection_init(struct gb_connection *connection)
785{
786 struct gb_svc *svc = connection->private;
787
788 dev_dbg(&svc->dev, "%s\n", __func__);
Johan Hovoldefe6ef72015-11-25 15:59:06 +0100789
Viresh Kumar18d777c2015-07-21 17:44:20 +0530790 return 0;
Alex Elder30c6d9d2015-05-22 13:02:08 -0500791}
792
793static void gb_svc_connection_exit(struct gb_connection *connection)
794{
795 struct gb_svc *svc = connection->private;
796
Johan Hovold7adeaae72015-12-07 15:05:37 +0100797 dev_dbg(&svc->dev, "%s\n", __func__);
Alex Elder30c6d9d2015-05-22 13:02:08 -0500798}
799
800static struct gb_protocol svc_protocol = {
801 .name = "svc",
802 .id = GREYBUS_PROTOCOL_SVC,
Viresh Kumar06e305f2015-07-01 12:13:51 +0530803 .major = GB_SVC_VERSION_MAJOR,
804 .minor = GB_SVC_VERSION_MINOR,
Alex Elder30c6d9d2015-05-22 13:02:08 -0500805 .connection_init = gb_svc_connection_init,
806 .connection_exit = gb_svc_connection_exit,
807 .request_recv = gb_svc_request_recv,
Viresh Kumar5a5296b2015-09-07 16:01:24 +0530808 .flags = GB_PROTOCOL_SKIP_CONTROL_CONNECTED |
809 GB_PROTOCOL_SKIP_CONTROL_DISCONNECTED |
Johan Hovold4ec15742015-11-25 15:59:13 +0100810 GB_PROTOCOL_SKIP_VERSION,
Alex Elder30c6d9d2015-05-22 13:02:08 -0500811};
Viresh Kumarab69c4c2015-07-03 17:00:29 +0530812gb_builtin_protocol_driver(svc_protocol);