2 * BOOTROM Greybus driver.
4 * Copyright 2016 Google Inc.
5 * Copyright 2016 Linaro Ltd.
7 * Released under the GPLv2 only.
10 #include <linux/firmware.h>
11 #include <linux/jiffies.h>
12 #include <linux/mutex.h>
13 #include <linux/workqueue.h>
18 /* Timeout, in jiffies, within which the next request must be received */
19 #define NEXT_REQ_TIMEOUT_MS 1000
22 * FIXME: Reduce this timeout once svc core handles parallel processing of
23 * events from the SVC, which are handled sequentially today.
25 #define MODE_SWITCH_TIMEOUT_MS 10000
27 enum next_request_type {
28 NEXT_REQ_FIRMWARE_SIZE,
29 NEXT_REQ_GET_FIRMWARE,
30 NEXT_REQ_READY_TO_BOOT,
35 struct gb_connection *connection;
36 const struct firmware *fw;
39 enum next_request_type next_request;
40 struct delayed_work dwork;
41 struct mutex mutex; /* Protects bootrom->fw */
44 static void free_firmware(struct gb_bootrom *bootrom)
49 release_firmware(bootrom->fw);
53 static void gb_bootrom_timedout(struct work_struct *work)
55 struct delayed_work *dwork = to_delayed_work(work);
56 struct gb_bootrom *bootrom = container_of(dwork, struct gb_bootrom, dwork);
57 struct device *dev = &bootrom->connection->bundle->dev;
60 switch (bootrom->next_request) {
61 case NEXT_REQ_FIRMWARE_SIZE:
62 reason = "Firmware Size Request";
64 case NEXT_REQ_GET_FIRMWARE:
65 reason = "Get Firmware Request";
67 case NEXT_REQ_READY_TO_BOOT:
68 reason = "Ready to Boot Request";
70 case NEXT_REQ_MODE_SWITCH:
71 reason = "Interface Mode Switch";
75 dev_err(dev, "Invalid next-request: %u", bootrom->next_request);
79 dev_err(dev, "Timed out waiting for %s from the Module\n", reason);
81 mutex_lock(&bootrom->mutex);
82 free_firmware(bootrom);
83 mutex_unlock(&bootrom->mutex);
85 /* TODO: Power-off Module ? */
88 static void gb_bootrom_set_timeout(struct gb_bootrom *bootrom,
89 enum next_request_type next, unsigned long timeout)
91 bootrom->next_request = next;
92 schedule_delayed_work(&bootrom->dwork, msecs_to_jiffies(timeout));
95 static void gb_bootrom_cancel_timeout(struct gb_bootrom *bootrom)
97 cancel_delayed_work_sync(&bootrom->dwork);
101 * The es2 chip doesn't have VID/PID programmed into the hardware and we need to
102 * hack that up to distinguish different modules and their firmware blobs.
104 * This fetches VID/PID (over bootrom protocol) for es2 chip only, when VID/PID
105 * already sent during hotplug are 0.
107 * Otherwise, we keep intf->vendor_id/product_id same as what's passed
110 static void bootrom_es2_fixup_vid_pid(struct gb_bootrom *bootrom)
112 struct gb_bootrom_get_vid_pid_response response;
113 struct gb_connection *connection = bootrom->connection;
114 struct gb_interface *intf = connection->bundle->intf;
117 if (!(intf->quirks & GB_INTERFACE_QUIRK_NO_GMP_IDS))
120 ret = gb_operation_sync(connection, GB_BOOTROM_TYPE_GET_VID_PID,
121 NULL, 0, &response, sizeof(response));
123 dev_err(&connection->bundle->dev,
124 "Bootrom get vid/pid operation failed (%d)\n", ret);
129 * NOTE: This is hacked, so that the same values of VID/PID can be used
130 * by next firmware level as well. The uevent for bootrom will still
131 * have VID/PID as 0, though after this point the sysfs files will start
132 * showing the updated values. But yeah, that's a bit racy as the same
133 * sysfs files would be showing 0 before this point.
135 intf->vendor_id = le32_to_cpu(response.vendor_id);
136 intf->product_id = le32_to_cpu(response.product_id);
138 dev_dbg(&connection->bundle->dev, "Bootrom got vid (0x%x)/pid (0x%x)\n",
139 intf->vendor_id, intf->product_id);
142 /* This returns path of the firmware blob on the disk */
143 static int find_firmware(struct gb_bootrom *bootrom, u8 stage)
145 struct gb_connection *connection = bootrom->connection;
146 struct gb_interface *intf = connection->bundle->intf;
147 char firmware_name[49];
150 /* Already have a firmware, free it */
151 free_firmware(bootrom);
153 /* Bootrom protocol is only supported for loading Stage 2 firmware */
155 dev_err(&connection->bundle->dev, "Invalid boot stage: %u\n",
161 * Create firmware name
163 * XXX Name it properly..
165 snprintf(firmware_name, sizeof(firmware_name),
166 FW_NAME_PREFIX "/*(DEBLOBBED)*/",
167 intf->ddbl1_manufacturer_id, intf->ddbl1_product_id,
168 intf->vendor_id, intf->product_id);
171 // Turn to dev_dbg later after everyone has valid bootloaders with good
172 // ids, but leave this as dev_info for now to make it easier to track
173 // down "empty" vid/pid modules.
174 dev_info(&connection->bundle->dev, "Firmware file '%s' requested\n",
177 rc = reject_firmware(&bootrom->fw, firmware_name,
178 &connection->bundle->dev);
180 dev_err(&connection->bundle->dev,
181 "failed to find %s firmware (%d)\n", firmware_name, rc);
187 static int gb_bootrom_firmware_size_request(struct gb_operation *op)
189 struct gb_bootrom *bootrom = gb_connection_get_data(op->connection);
190 struct gb_bootrom_firmware_size_request *size_request = op->request->payload;
191 struct gb_bootrom_firmware_size_response *size_response;
192 struct device *dev = &op->connection->bundle->dev;
195 /* Disable timeouts */
196 gb_bootrom_cancel_timeout(bootrom);
198 if (op->request->payload_size != sizeof(*size_request)) {
199 dev_err(dev, "%s: illegal size of firmware size request (%zu != %zu)\n",
200 __func__, op->request->payload_size,
201 sizeof(*size_request));
206 mutex_lock(&bootrom->mutex);
208 ret = find_firmware(bootrom, size_request->stage);
212 if (!gb_operation_response_alloc(op, sizeof(*size_response),
214 dev_err(dev, "%s: error allocating response\n", __func__);
215 free_firmware(bootrom);
220 size_response = op->response->payload;
221 size_response->size = cpu_to_le32(bootrom->fw->size);
223 dev_dbg(dev, "%s: firmware size %d bytes\n", __func__, size_response->size);
226 mutex_unlock(&bootrom->mutex);
230 /* Refresh timeout */
231 gb_bootrom_set_timeout(bootrom, NEXT_REQ_GET_FIRMWARE,
232 NEXT_REQ_TIMEOUT_MS);
238 static int gb_bootrom_get_firmware(struct gb_operation *op)
240 struct gb_bootrom *bootrom = gb_connection_get_data(op->connection);
241 const struct firmware *fw;
242 struct gb_bootrom_get_firmware_request *firmware_request;
243 struct gb_bootrom_get_firmware_response *firmware_response;
244 struct device *dev = &op->connection->bundle->dev;
245 unsigned int offset, size;
246 enum next_request_type next_request;
249 /* Disable timeouts */
250 gb_bootrom_cancel_timeout(bootrom);
252 if (op->request->payload_size != sizeof(*firmware_request)) {
253 dev_err(dev, "%s: Illegal size of get firmware request (%zu %zu)\n",
254 __func__, op->request->payload_size,
255 sizeof(*firmware_request));
260 mutex_lock(&bootrom->mutex);
264 dev_err(dev, "%s: firmware not available\n", __func__);
269 firmware_request = op->request->payload;
270 offset = le32_to_cpu(firmware_request->offset);
271 size = le32_to_cpu(firmware_request->size);
273 if (offset >= fw->size || size > fw->size - offset) {
274 dev_warn(dev, "bad firmware request (offs = %u, size = %u)\n",
280 if (!gb_operation_response_alloc(op, sizeof(*firmware_response) + size,
282 dev_err(dev, "%s: error allocating response\n", __func__);
287 firmware_response = op->response->payload;
288 memcpy(firmware_response->data, fw->data + offset, size);
290 dev_dbg(dev, "responding with firmware (offs = %u, size = %u)\n", offset,
294 mutex_unlock(&bootrom->mutex);
297 /* Refresh timeout */
298 if (!ret && (offset + size == fw->size))
299 next_request = NEXT_REQ_READY_TO_BOOT;
301 next_request = NEXT_REQ_GET_FIRMWARE;
303 gb_bootrom_set_timeout(bootrom, next_request, NEXT_REQ_TIMEOUT_MS);
308 static int gb_bootrom_ready_to_boot(struct gb_operation *op)
310 struct gb_connection *connection = op->connection;
311 struct gb_bootrom *bootrom = gb_connection_get_data(connection);
312 struct gb_bootrom_ready_to_boot_request *rtb_request;
313 struct device *dev = &connection->bundle->dev;
317 /* Disable timeouts */
318 gb_bootrom_cancel_timeout(bootrom);
320 if (op->request->payload_size != sizeof(*rtb_request)) {
321 dev_err(dev, "%s: Illegal size of ready to boot request (%zu %zu)\n",
322 __func__, op->request->payload_size,
323 sizeof(*rtb_request));
328 rtb_request = op->request->payload;
329 status = rtb_request->status;
331 /* Return error if the blob was invalid */
332 if (status == GB_BOOTROM_BOOT_STATUS_INVALID) {
338 * XXX Should we return error for insecure firmware?
340 dev_dbg(dev, "ready to boot: 0x%x, 0\n", status);
344 * Refresh timeout, the Interface shall load the new personality and
345 * send a new hotplug request, which shall get rid of the bootrom
346 * connection. As that can take some time, increase the timeout a bit.
348 gb_bootrom_set_timeout(bootrom, NEXT_REQ_MODE_SWITCH,
349 MODE_SWITCH_TIMEOUT_MS);
354 static int gb_bootrom_request_handler(struct gb_operation *op)
359 case GB_BOOTROM_TYPE_FIRMWARE_SIZE:
360 return gb_bootrom_firmware_size_request(op);
361 case GB_BOOTROM_TYPE_GET_FIRMWARE:
362 return gb_bootrom_get_firmware(op);
363 case GB_BOOTROM_TYPE_READY_TO_BOOT:
364 return gb_bootrom_ready_to_boot(op);
366 dev_err(&op->connection->bundle->dev,
367 "unsupported request: %u\n", type);
372 static int gb_bootrom_get_version(struct gb_bootrom *bootrom)
374 struct gb_bundle *bundle = bootrom->connection->bundle;
375 struct gb_bootrom_version_request request;
376 struct gb_bootrom_version_response response;
379 request.major = GB_BOOTROM_VERSION_MAJOR;
380 request.minor = GB_BOOTROM_VERSION_MINOR;
382 ret = gb_operation_sync(bootrom->connection,
383 GB_BOOTROM_TYPE_VERSION,
384 &request, sizeof(request), &response,
387 dev_err(&bundle->dev,
388 "failed to get protocol version: %d\n",
393 if (response.major > request.major) {
394 dev_err(&bundle->dev,
395 "unsupported major protocol version (%u > %u)\n",
396 response.major, request.major);
400 bootrom->protocol_major = response.major;
401 bootrom->protocol_minor = response.minor;
403 dev_dbg(&bundle->dev, "%s - %u.%u\n", __func__, response.major,
409 static int gb_bootrom_probe(struct gb_bundle *bundle,
410 const struct greybus_bundle_id *id)
412 struct greybus_descriptor_cport *cport_desc;
413 struct gb_connection *connection;
414 struct gb_bootrom *bootrom;
417 if (bundle->num_cports != 1)
420 cport_desc = &bundle->cport_desc[0];
421 if (cport_desc->protocol_id != GREYBUS_PROTOCOL_BOOTROM)
424 bootrom = kzalloc(sizeof(*bootrom), GFP_KERNEL);
428 connection = gb_connection_create(bundle,
429 le16_to_cpu(cport_desc->id),
430 gb_bootrom_request_handler);
431 if (IS_ERR(connection)) {
432 ret = PTR_ERR(connection);
433 goto err_free_bootrom;
436 gb_connection_set_data(connection, bootrom);
438 bootrom->connection = connection;
440 mutex_init(&bootrom->mutex);
441 INIT_DELAYED_WORK(&bootrom->dwork, gb_bootrom_timedout);
442 greybus_set_drvdata(bundle, bootrom);
444 ret = gb_connection_enable_tx(connection);
446 goto err_connection_destroy;
448 ret = gb_bootrom_get_version(bootrom);
450 goto err_connection_disable;
452 bootrom_es2_fixup_vid_pid(bootrom);
454 ret = gb_connection_enable(connection);
456 goto err_connection_disable;
458 /* Refresh timeout */
459 gb_bootrom_set_timeout(bootrom, NEXT_REQ_FIRMWARE_SIZE,
460 NEXT_REQ_TIMEOUT_MS);
462 /* Tell bootrom we're ready. */
463 ret = gb_operation_sync(connection, GB_BOOTROM_TYPE_AP_READY, NULL, 0,
466 dev_err(&connection->bundle->dev,
467 "failed to send AP READY: %d\n", ret);
468 goto err_cancel_timeout;
471 dev_dbg(&bundle->dev, "AP_READY sent\n");
476 gb_bootrom_cancel_timeout(bootrom);
477 err_connection_disable:
478 gb_connection_disable(connection);
479 err_connection_destroy:
480 gb_connection_destroy(connection);
487 static void gb_bootrom_disconnect(struct gb_bundle *bundle)
489 struct gb_bootrom *bootrom = greybus_get_drvdata(bundle);
491 dev_dbg(&bundle->dev, "%s\n", __func__);
493 gb_connection_disable(bootrom->connection);
495 /* Disable timeouts */
496 gb_bootrom_cancel_timeout(bootrom);
501 * As the connection and the delayed work are already disabled, we don't
502 * need to lock access to bootrom->fw here.
504 free_firmware(bootrom);
506 gb_connection_destroy(bootrom->connection);
510 static const struct greybus_bundle_id gb_bootrom_id_table[] = {
511 { GREYBUS_DEVICE_CLASS(GREYBUS_CLASS_BOOTROM) },
515 static struct greybus_driver gb_bootrom_driver = {
517 .probe = gb_bootrom_probe,
518 .disconnect = gb_bootrom_disconnect,
519 .id_table = gb_bootrom_id_table,
522 module_greybus_driver(gb_bootrom_driver);
524 MODULE_LICENSE("GPL v2");