1 // SPDX-License-Identifier: GPL-2.0
3 * Greybus Firmware Management Protocol Driver.
5 * Copyright 2016 Google Inc.
6 * Copyright 2016 Linaro Ltd.
9 #include <linux/cdev.h>
10 #include <linux/completion.h>
11 #include <linux/firmware.h>
13 #include <linux/idr.h>
14 #include <linux/ioctl.h>
15 #include <linux/uaccess.h>
16 #include <linux/greybus.h>
19 #include "greybus_firmware.h"
21 #define FW_MGMT_TIMEOUT_MS 1000
24 struct device
*parent
;
25 struct gb_connection
*connection
;
27 struct list_head node
;
29 /* Common id-map for interface and backend firmware requests */
32 struct completion completion
;
34 struct device
*class_device
;
36 unsigned int timeout_jiffies
;
37 bool disabled
; /* connection getting disabled */
39 /* Interface Firmware specific fields */
40 bool mode_switch_started
;
42 u8 intf_fw_request_id
;
47 /* Backend Firmware specific fields */
48 u8 backend_fw_request_id
;
53 * Number of minor devices this driver supports.
54 * There will be exactly one required per Interface.
56 #define NUM_MINORS U8_MAX
58 static const struct class fw_mgmt_class
= {
62 static dev_t fw_mgmt_dev_num
;
63 static DEFINE_IDA(fw_mgmt_minors_map
);
64 static LIST_HEAD(fw_mgmt_list
);
65 static DEFINE_MUTEX(list_mutex
);
67 static void fw_mgmt_kref_release(struct kref
*kref
)
69 struct fw_mgmt
*fw_mgmt
= container_of(kref
, struct fw_mgmt
, kref
);
71 ida_destroy(&fw_mgmt
->id_map
);
76 * All users of fw_mgmt take a reference (from within list_mutex lock), before
77 * they get a pointer to play with. And the structure will be freed only after
78 * the last user has put the reference to it.
80 static void put_fw_mgmt(struct fw_mgmt
*fw_mgmt
)
82 kref_put(&fw_mgmt
->kref
, fw_mgmt_kref_release
);
85 /* Caller must call put_fw_mgmt() after using struct fw_mgmt */
86 static struct fw_mgmt
*get_fw_mgmt(struct cdev
*cdev
)
88 struct fw_mgmt
*fw_mgmt
;
90 mutex_lock(&list_mutex
);
92 list_for_each_entry(fw_mgmt
, &fw_mgmt_list
, node
) {
93 if (&fw_mgmt
->cdev
== cdev
) {
94 kref_get(&fw_mgmt
->kref
);
102 mutex_unlock(&list_mutex
);
107 static int fw_mgmt_interface_fw_version_operation(struct fw_mgmt
*fw_mgmt
,
108 struct fw_mgmt_ioc_get_intf_version
*fw_info
)
110 struct gb_connection
*connection
= fw_mgmt
->connection
;
111 struct gb_fw_mgmt_interface_fw_version_response response
;
114 ret
= gb_operation_sync(connection
,
115 GB_FW_MGMT_TYPE_INTERFACE_FW_VERSION
, NULL
, 0,
116 &response
, sizeof(response
));
118 dev_err(fw_mgmt
->parent
,
119 "failed to get interface firmware version (%d)\n", ret
);
123 fw_info
->major
= le16_to_cpu(response
.major
);
124 fw_info
->minor
= le16_to_cpu(response
.minor
);
126 strscpy_pad(fw_info
->firmware_tag
, response
.firmware_tag
);
129 * The firmware-tag should be NULL terminated, otherwise throw error but
132 if (fw_info
->firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
- 1] != '\0') {
133 dev_err(fw_mgmt
->parent
,
134 "fw-version: firmware-tag is not NULL terminated\n");
135 fw_info
->firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
- 1] = '\0';
141 static int fw_mgmt_load_and_validate_operation(struct fw_mgmt
*fw_mgmt
,
142 u8 load_method
, const char *tag
)
144 struct gb_fw_mgmt_load_and_validate_fw_request request
;
147 if (load_method
!= GB_FW_LOAD_METHOD_UNIPRO
&&
148 load_method
!= GB_FW_LOAD_METHOD_INTERNAL
) {
149 dev_err(fw_mgmt
->parent
,
150 "invalid load-method (%d)\n", load_method
);
154 request
.load_method
= load_method
;
155 strscpy_pad(request
.firmware_tag
, tag
);
158 * The firmware-tag should be NULL terminated, otherwise throw error and
161 if (request
.firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
- 1] != '\0') {
162 dev_err(fw_mgmt
->parent
, "load-and-validate: firmware-tag is not NULL terminated\n");
166 /* Allocate ids from 1 to 255 (u8-max), 0 is an invalid id */
167 ret
= ida_alloc_range(&fw_mgmt
->id_map
, 1, 255, GFP_KERNEL
);
169 dev_err(fw_mgmt
->parent
, "failed to allocate request id (%d)\n",
174 fw_mgmt
->intf_fw_request_id
= ret
;
175 fw_mgmt
->intf_fw_loaded
= false;
176 request
.request_id
= ret
;
178 ret
= gb_operation_sync(fw_mgmt
->connection
,
179 GB_FW_MGMT_TYPE_LOAD_AND_VALIDATE_FW
, &request
,
180 sizeof(request
), NULL
, 0);
182 ida_free(&fw_mgmt
->id_map
, fw_mgmt
->intf_fw_request_id
);
183 fw_mgmt
->intf_fw_request_id
= 0;
184 dev_err(fw_mgmt
->parent
,
185 "load and validate firmware request failed (%d)\n",
193 static int fw_mgmt_interface_fw_loaded_operation(struct gb_operation
*op
)
195 struct gb_connection
*connection
= op
->connection
;
196 struct fw_mgmt
*fw_mgmt
= gb_connection_get_data(connection
);
197 struct gb_fw_mgmt_loaded_fw_request
*request
;
199 /* No pending load and validate request ? */
200 if (!fw_mgmt
->intf_fw_request_id
) {
201 dev_err(fw_mgmt
->parent
,
202 "unexpected firmware loaded request received\n");
206 if (op
->request
->payload_size
!= sizeof(*request
)) {
207 dev_err(fw_mgmt
->parent
, "illegal size of firmware loaded request (%zu != %zu)\n",
208 op
->request
->payload_size
, sizeof(*request
));
212 request
= op
->request
->payload
;
214 /* Invalid request-id ? */
215 if (request
->request_id
!= fw_mgmt
->intf_fw_request_id
) {
216 dev_err(fw_mgmt
->parent
, "invalid request id for firmware loaded request (%02u != %02u)\n",
217 fw_mgmt
->intf_fw_request_id
, request
->request_id
);
221 ida_free(&fw_mgmt
->id_map
, fw_mgmt
->intf_fw_request_id
);
222 fw_mgmt
->intf_fw_request_id
= 0;
223 fw_mgmt
->intf_fw_status
= request
->status
;
224 fw_mgmt
->intf_fw_major
= le16_to_cpu(request
->major
);
225 fw_mgmt
->intf_fw_minor
= le16_to_cpu(request
->minor
);
227 if (fw_mgmt
->intf_fw_status
== GB_FW_LOAD_STATUS_FAILED
)
228 dev_err(fw_mgmt
->parent
,
229 "failed to load interface firmware, status:%02x\n",
230 fw_mgmt
->intf_fw_status
);
231 else if (fw_mgmt
->intf_fw_status
== GB_FW_LOAD_STATUS_VALIDATION_FAILED
)
232 dev_err(fw_mgmt
->parent
,
233 "failed to validate interface firmware, status:%02x\n",
234 fw_mgmt
->intf_fw_status
);
236 fw_mgmt
->intf_fw_loaded
= true;
238 complete(&fw_mgmt
->completion
);
243 static int fw_mgmt_backend_fw_version_operation(struct fw_mgmt
*fw_mgmt
,
244 struct fw_mgmt_ioc_get_backend_version
*fw_info
)
246 struct gb_connection
*connection
= fw_mgmt
->connection
;
247 struct gb_fw_mgmt_backend_fw_version_request request
;
248 struct gb_fw_mgmt_backend_fw_version_response response
;
251 strscpy_pad(request
.firmware_tag
, fw_info
->firmware_tag
);
254 * The firmware-tag should be NULL terminated, otherwise throw error and
257 if (request
.firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
- 1] != '\0') {
258 dev_err(fw_mgmt
->parent
, "backend-version: firmware-tag is not NULL terminated\n");
262 ret
= gb_operation_sync(connection
,
263 GB_FW_MGMT_TYPE_BACKEND_FW_VERSION
, &request
,
264 sizeof(request
), &response
, sizeof(response
));
266 dev_err(fw_mgmt
->parent
, "failed to get version of %s backend firmware (%d)\n",
267 fw_info
->firmware_tag
, ret
);
271 fw_info
->status
= response
.status
;
273 /* Reset version as that should be non-zero only for success case */
277 switch (fw_info
->status
) {
278 case GB_FW_BACKEND_VERSION_STATUS_SUCCESS
:
279 fw_info
->major
= le16_to_cpu(response
.major
);
280 fw_info
->minor
= le16_to_cpu(response
.minor
);
282 case GB_FW_BACKEND_VERSION_STATUS_NOT_AVAILABLE
:
283 case GB_FW_BACKEND_VERSION_STATUS_RETRY
:
285 case GB_FW_BACKEND_VERSION_STATUS_NOT_SUPPORTED
:
286 dev_err(fw_mgmt
->parent
,
287 "Firmware with tag %s is not supported by Interface\n",
288 fw_info
->firmware_tag
);
291 dev_err(fw_mgmt
->parent
, "Invalid status received: %u\n",
298 static int fw_mgmt_backend_fw_update_operation(struct fw_mgmt
*fw_mgmt
,
301 struct gb_fw_mgmt_backend_fw_update_request request
;
304 ret
= strscpy_pad(request
.firmware_tag
, tag
);
307 * The firmware-tag should be NULL terminated, otherwise throw error and
311 dev_err(fw_mgmt
->parent
, "backend-update: firmware-tag is not NULL terminated\n");
315 /* Allocate ids from 1 to 255 (u8-max), 0 is an invalid id */
316 ret
= ida_alloc_range(&fw_mgmt
->id_map
, 1, 255, GFP_KERNEL
);
318 dev_err(fw_mgmt
->parent
, "failed to allocate request id (%d)\n",
323 fw_mgmt
->backend_fw_request_id
= ret
;
324 request
.request_id
= ret
;
326 ret
= gb_operation_sync(fw_mgmt
->connection
,
327 GB_FW_MGMT_TYPE_BACKEND_FW_UPDATE
, &request
,
328 sizeof(request
), NULL
, 0);
330 ida_free(&fw_mgmt
->id_map
, fw_mgmt
->backend_fw_request_id
);
331 fw_mgmt
->backend_fw_request_id
= 0;
332 dev_err(fw_mgmt
->parent
,
333 "backend %s firmware update request failed (%d)\n", tag
,
341 static int fw_mgmt_backend_fw_updated_operation(struct gb_operation
*op
)
343 struct gb_connection
*connection
= op
->connection
;
344 struct fw_mgmt
*fw_mgmt
= gb_connection_get_data(connection
);
345 struct gb_fw_mgmt_backend_fw_updated_request
*request
;
347 /* No pending load and validate request ? */
348 if (!fw_mgmt
->backend_fw_request_id
) {
349 dev_err(fw_mgmt
->parent
, "unexpected backend firmware updated request received\n");
353 if (op
->request
->payload_size
!= sizeof(*request
)) {
354 dev_err(fw_mgmt
->parent
, "illegal size of backend firmware updated request (%zu != %zu)\n",
355 op
->request
->payload_size
, sizeof(*request
));
359 request
= op
->request
->payload
;
361 /* Invalid request-id ? */
362 if (request
->request_id
!= fw_mgmt
->backend_fw_request_id
) {
363 dev_err(fw_mgmt
->parent
, "invalid request id for backend firmware updated request (%02u != %02u)\n",
364 fw_mgmt
->backend_fw_request_id
, request
->request_id
);
368 ida_free(&fw_mgmt
->id_map
, fw_mgmt
->backend_fw_request_id
);
369 fw_mgmt
->backend_fw_request_id
= 0;
370 fw_mgmt
->backend_fw_status
= request
->status
;
372 if ((fw_mgmt
->backend_fw_status
!= GB_FW_BACKEND_FW_STATUS_SUCCESS
) &&
373 (fw_mgmt
->backend_fw_status
!= GB_FW_BACKEND_FW_STATUS_RETRY
))
374 dev_err(fw_mgmt
->parent
,
375 "failed to load backend firmware: %02x\n",
376 fw_mgmt
->backend_fw_status
);
378 complete(&fw_mgmt
->completion
);
383 /* Char device fops */
385 static int fw_mgmt_open(struct inode
*inode
, struct file
*file
)
387 struct fw_mgmt
*fw_mgmt
= get_fw_mgmt(inode
->i_cdev
);
389 /* fw_mgmt structure can't get freed until file descriptor is closed */
391 file
->private_data
= fw_mgmt
;
398 static int fw_mgmt_release(struct inode
*inode
, struct file
*file
)
400 struct fw_mgmt
*fw_mgmt
= file
->private_data
;
402 put_fw_mgmt(fw_mgmt
);
406 static int fw_mgmt_ioctl(struct fw_mgmt
*fw_mgmt
, unsigned int cmd
,
409 struct fw_mgmt_ioc_get_intf_version intf_fw_info
;
410 struct fw_mgmt_ioc_get_backend_version backend_fw_info
;
411 struct fw_mgmt_ioc_intf_load_and_validate intf_load
;
412 struct fw_mgmt_ioc_backend_fw_update backend_update
;
413 unsigned int timeout
;
416 /* Reject any operations after mode-switch has started */
417 if (fw_mgmt
->mode_switch_started
)
421 case FW_MGMT_IOC_GET_INTF_FW
:
422 ret
= fw_mgmt_interface_fw_version_operation(fw_mgmt
,
427 if (copy_to_user(buf
, &intf_fw_info
, sizeof(intf_fw_info
)))
431 case FW_MGMT_IOC_GET_BACKEND_FW
:
432 if (copy_from_user(&backend_fw_info
, buf
,
433 sizeof(backend_fw_info
)))
436 ret
= fw_mgmt_backend_fw_version_operation(fw_mgmt
,
441 if (copy_to_user(buf
, &backend_fw_info
,
442 sizeof(backend_fw_info
)))
446 case FW_MGMT_IOC_INTF_LOAD_AND_VALIDATE
:
447 if (copy_from_user(&intf_load
, buf
, sizeof(intf_load
)))
450 ret
= fw_mgmt_load_and_validate_operation(fw_mgmt
,
451 intf_load
.load_method
, intf_load
.firmware_tag
);
455 if (!wait_for_completion_timeout(&fw_mgmt
->completion
,
456 fw_mgmt
->timeout_jiffies
)) {
457 dev_err(fw_mgmt
->parent
, "timed out waiting for firmware load and validation to finish\n");
461 intf_load
.status
= fw_mgmt
->intf_fw_status
;
462 intf_load
.major
= fw_mgmt
->intf_fw_major
;
463 intf_load
.minor
= fw_mgmt
->intf_fw_minor
;
465 if (copy_to_user(buf
, &intf_load
, sizeof(intf_load
)))
469 case FW_MGMT_IOC_INTF_BACKEND_FW_UPDATE
:
470 if (copy_from_user(&backend_update
, buf
,
471 sizeof(backend_update
)))
474 ret
= fw_mgmt_backend_fw_update_operation(fw_mgmt
,
475 backend_update
.firmware_tag
);
479 if (!wait_for_completion_timeout(&fw_mgmt
->completion
,
480 fw_mgmt
->timeout_jiffies
)) {
481 dev_err(fw_mgmt
->parent
, "timed out waiting for backend firmware update to finish\n");
485 backend_update
.status
= fw_mgmt
->backend_fw_status
;
487 if (copy_to_user(buf
, &backend_update
, sizeof(backend_update
)))
491 case FW_MGMT_IOC_SET_TIMEOUT_MS
:
492 if (get_user(timeout
, (unsigned int __user
*)buf
))
496 dev_err(fw_mgmt
->parent
, "timeout can't be zero\n");
500 fw_mgmt
->timeout_jiffies
= msecs_to_jiffies(timeout
);
503 case FW_MGMT_IOC_MODE_SWITCH
:
504 if (!fw_mgmt
->intf_fw_loaded
) {
505 dev_err(fw_mgmt
->parent
,
506 "Firmware not loaded for mode-switch\n");
511 * Disallow new ioctls as the fw-core bundle driver is going to
512 * get disconnected soon and the character device will get
515 fw_mgmt
->mode_switch_started
= true;
517 ret
= gb_interface_request_mode_switch(fw_mgmt
->connection
->intf
);
519 dev_err(fw_mgmt
->parent
, "Mode-switch failed: %d\n",
521 fw_mgmt
->mode_switch_started
= false;
531 static long fw_mgmt_ioctl_unlocked(struct file
*file
, unsigned int cmd
,
534 struct fw_mgmt
*fw_mgmt
= file
->private_data
;
535 struct gb_bundle
*bundle
= fw_mgmt
->connection
->bundle
;
541 * We don't want the user to do few operations in parallel. For example,
542 * updating Interface firmware in parallel for the same Interface. There
543 * is no need to do things in parallel for speed and we can avoid having
544 * complicated code for now.
546 * This is also used to protect ->disabled, which is used to check if
547 * the connection is getting disconnected, so that we don't start any
550 mutex_lock(&fw_mgmt
->mutex
);
551 if (!fw_mgmt
->disabled
) {
552 ret
= gb_pm_runtime_get_sync(bundle
);
554 ret
= fw_mgmt_ioctl(fw_mgmt
, cmd
, (void __user
*)arg
);
555 gb_pm_runtime_put_autosuspend(bundle
);
558 mutex_unlock(&fw_mgmt
->mutex
);
563 static const struct file_operations fw_mgmt_fops
= {
564 .owner
= THIS_MODULE
,
565 .open
= fw_mgmt_open
,
566 .release
= fw_mgmt_release
,
567 .unlocked_ioctl
= fw_mgmt_ioctl_unlocked
,
570 int gb_fw_mgmt_request_handler(struct gb_operation
*op
)
575 case GB_FW_MGMT_TYPE_LOADED_FW
:
576 return fw_mgmt_interface_fw_loaded_operation(op
);
577 case GB_FW_MGMT_TYPE_BACKEND_FW_UPDATED
:
578 return fw_mgmt_backend_fw_updated_operation(op
);
580 dev_err(&op
->connection
->bundle
->dev
,
581 "unsupported request: %u\n", type
);
586 int gb_fw_mgmt_connection_init(struct gb_connection
*connection
)
588 struct fw_mgmt
*fw_mgmt
;
594 fw_mgmt
= kzalloc(sizeof(*fw_mgmt
), GFP_KERNEL
);
598 fw_mgmt
->parent
= &connection
->bundle
->dev
;
599 fw_mgmt
->timeout_jiffies
= msecs_to_jiffies(FW_MGMT_TIMEOUT_MS
);
600 fw_mgmt
->connection
= connection
;
602 gb_connection_set_data(connection
, fw_mgmt
);
603 init_completion(&fw_mgmt
->completion
);
604 ida_init(&fw_mgmt
->id_map
);
605 mutex_init(&fw_mgmt
->mutex
);
606 kref_init(&fw_mgmt
->kref
);
608 mutex_lock(&list_mutex
);
609 list_add(&fw_mgmt
->node
, &fw_mgmt_list
);
610 mutex_unlock(&list_mutex
);
612 ret
= gb_connection_enable(connection
);
616 minor
= ida_alloc_max(&fw_mgmt_minors_map
, NUM_MINORS
- 1, GFP_KERNEL
);
619 goto err_connection_disable
;
622 /* Add a char device to allow userspace to interact with fw-mgmt */
623 fw_mgmt
->dev_num
= MKDEV(MAJOR(fw_mgmt_dev_num
), minor
);
624 cdev_init(&fw_mgmt
->cdev
, &fw_mgmt_fops
);
626 ret
= cdev_add(&fw_mgmt
->cdev
, fw_mgmt
->dev_num
, 1);
630 /* Add a soft link to the previously added char-dev within the bundle */
631 fw_mgmt
->class_device
= device_create(&fw_mgmt_class
, fw_mgmt
->parent
,
632 fw_mgmt
->dev_num
, NULL
,
633 "gb-fw-mgmt-%d", minor
);
634 if (IS_ERR(fw_mgmt
->class_device
)) {
635 ret
= PTR_ERR(fw_mgmt
->class_device
);
642 cdev_del(&fw_mgmt
->cdev
);
644 ida_free(&fw_mgmt_minors_map
, minor
);
645 err_connection_disable
:
646 gb_connection_disable(connection
);
648 mutex_lock(&list_mutex
);
649 list_del(&fw_mgmt
->node
);
650 mutex_unlock(&list_mutex
);
652 put_fw_mgmt(fw_mgmt
);
657 void gb_fw_mgmt_connection_exit(struct gb_connection
*connection
)
659 struct fw_mgmt
*fw_mgmt
;
664 fw_mgmt
= gb_connection_get_data(connection
);
666 device_destroy(&fw_mgmt_class
, fw_mgmt
->dev_num
);
667 cdev_del(&fw_mgmt
->cdev
);
668 ida_free(&fw_mgmt_minors_map
, MINOR(fw_mgmt
->dev_num
));
671 * Disallow any new ioctl operations on the char device and wait for
672 * existing ones to finish.
674 mutex_lock(&fw_mgmt
->mutex
);
675 fw_mgmt
->disabled
= true;
676 mutex_unlock(&fw_mgmt
->mutex
);
678 /* All pending greybus operations should have finished by now */
679 gb_connection_disable(fw_mgmt
->connection
);
681 /* Disallow new users to get access to the fw_mgmt structure */
682 mutex_lock(&list_mutex
);
683 list_del(&fw_mgmt
->node
);
684 mutex_unlock(&list_mutex
);
687 * All current users of fw_mgmt would have taken a reference to it by
688 * now, we can drop our reference and wait the last user will get
691 put_fw_mgmt(fw_mgmt
);
694 int fw_mgmt_init(void)
698 ret
= class_register(&fw_mgmt_class
);
702 ret
= alloc_chrdev_region(&fw_mgmt_dev_num
, 0, NUM_MINORS
,
705 goto err_remove_class
;
710 class_unregister(&fw_mgmt_class
);
714 void fw_mgmt_exit(void)
716 unregister_chrdev_region(fw_mgmt_dev_num
, NUM_MINORS
);
717 class_unregister(&fw_mgmt_class
);
718 ida_destroy(&fw_mgmt_minors_map
);