2 * Greybus Firmware Management User Header
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
9 * Copyright(c) 2016 Google Inc. All rights reserved.
10 * Copyright(c) 2016 Linaro Ltd. All rights reserved.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of version 2 of the GNU General Public License as
14 * published by the Free Software Foundation.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License version 2 for more details.
23 * Copyright(c) 2016 Google Inc. All rights reserved.
24 * Copyright(c) 2016 Linaro Ltd. All rights reserved.
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
30 * * Redistributions of source code must retain the above copyright
31 * notice, this list of conditions and the following disclaimer.
32 * * Redistributions in binary form must reproduce the above copyright
33 * notice, this list of conditions and the following disclaimer in
34 * the documentation and/or other materials provided with the
36 * * Neither the name of Google Inc. or Linaro Ltd. nor the names of
37 * its contributors may be used to endorse or promote products
38 * derived from this software without specific prior written
41 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
42 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
43 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
44 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC. OR
45 * LINARO LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
46 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
47 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
48 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
49 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
50 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
51 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifndef __GREYBUS_FIRMWARE_USER_H
55 #define __GREYBUS_FIRMWARE_USER_H
57 #include <linux/ioctl.h>
58 #include <linux/types.h>
60 #define GB_FIRMWARE_U_TAG_MAX_SIZE 10
62 #define GB_FW_U_LOAD_METHOD_UNIPRO 0x01
63 #define GB_FW_U_LOAD_METHOD_INTERNAL 0x02
65 #define GB_FW_U_LOAD_STATUS_FAILED 0x00
66 #define GB_FW_U_LOAD_STATUS_UNVALIDATED 0x01
67 #define GB_FW_U_LOAD_STATUS_VALIDATED 0x02
68 #define GB_FW_U_LOAD_STATUS_VALIDATION_FAILED 0x03
70 #define GB_FW_U_BACKEND_FW_STATUS_SUCCESS 0x01
71 #define GB_FW_U_BACKEND_FW_STATUS_FAIL_FIND 0x02
72 #define GB_FW_U_BACKEND_FW_STATUS_FAIL_FETCH 0x03
73 #define GB_FW_U_BACKEND_FW_STATUS_FAIL_WRITE 0x04
74 #define GB_FW_U_BACKEND_FW_STATUS_INT 0x05
75 #define GB_FW_U_BACKEND_FW_STATUS_RETRY 0x06
76 #define GB_FW_U_BACKEND_FW_STATUS_NOT_SUPPORTED 0x07
78 #define GB_FW_U_BACKEND_VERSION_STATUS_SUCCESS 0x01
79 #define GB_FW_U_BACKEND_VERSION_STATUS_NOT_AVAILABLE 0x02
80 #define GB_FW_U_BACKEND_VERSION_STATUS_NOT_SUPPORTED 0x03
81 #define GB_FW_U_BACKEND_VERSION_STATUS_RETRY 0x04
82 #define GB_FW_U_BACKEND_VERSION_STATUS_FAIL_INT 0x05
85 struct fw_mgmt_ioc_get_intf_version {
86 __u8 firmware_tag[GB_FIRMWARE_U_TAG_MAX_SIZE];
89 } __attribute__ ((__packed__));
91 struct fw_mgmt_ioc_get_backend_version {
92 __u8 firmware_tag[GB_FIRMWARE_U_TAG_MAX_SIZE];
96 } __attribute__ ((__packed__));
98 struct fw_mgmt_ioc_intf_load_and_validate {
99 __u8 firmware_tag[GB_FIRMWARE_U_TAG_MAX_SIZE];
104 } __attribute__ ((__packed__));
106 struct fw_mgmt_ioc_backend_fw_update {
107 __u8 firmware_tag[GB_FIRMWARE_U_TAG_MAX_SIZE];
109 } __attribute__ ((__packed__));
111 #define FW_MGMT_IOCTL_BASE 'F'
112 #define FW_MGMT_IOC_GET_INTF_FW _IOR(FW_MGMT_IOCTL_BASE, 0, struct fw_mgmt_ioc_get_intf_version)
113 #define FW_MGMT_IOC_GET_BACKEND_FW _IOWR(FW_MGMT_IOCTL_BASE, 1, struct fw_mgmt_ioc_get_backend_version)
114 #define FW_MGMT_IOC_INTF_LOAD_AND_VALIDATE _IOWR(FW_MGMT_IOCTL_BASE, 2, struct fw_mgmt_ioc_intf_load_and_validate)
115 #define FW_MGMT_IOC_INTF_BACKEND_FW_UPDATE _IOWR(FW_MGMT_IOCTL_BASE, 3, struct fw_mgmt_ioc_backend_fw_update)
116 #define FW_MGMT_IOC_SET_TIMEOUT_MS _IOW(FW_MGMT_IOCTL_BASE, 4, unsigned int)
117 #define FW_MGMT_IOC_MODE_SWITCH _IO(FW_MGMT_IOCTL_BASE, 5)
119 #endif /* __GREYBUS_FIRMWARE_USER_H */