tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

greybus: firmware: Fix typo in documentation

s/shall be used the user/shall be used by the user/

Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@google.com>

authored by

Viresh Kumar and committed by
Greg Kroah-Hartman d581bc88 295b5269

+26 -25
+26 -25
drivers/staging/greybus/Documentation/firmware/firmware-management
··· 139 139 140 140 1. FW_MGMT_IOC_GET_INTF_FW: 141 141 142 - This ioctl shall be used the user to get the version and firmware-tag of the 143 - currently running Interface Firmware. All the fields of the 'struct 142 + This ioctl shall be used by the user to get the version and firmware-tag of 143 + the currently running Interface Firmware. All the fields of the 'struct 144 144 fw_mgmt_ioc_get_fw' are filled by the kernel. 145 145 146 146 2. FW_MGMT_IOC_GET_BACKEND_FW: 147 147 148 - This ioctl shall be used the user to get the version of a currently running 149 - Backend Interface Firmware identified by a firmware-tag. The user is required 150 - to fill the 'firmware_tag' field of the 'struct fw_mgmt_ioc_get_fw' in this 151 - case. The 'major' and 'minor' fields are set by the kernel in response. 148 + This ioctl shall be used by the user to get the version of a currently 149 + running Backend Interface Firmware identified by a firmware-tag. The user is 150 + required to fill the 'firmware_tag' field of the 'struct fw_mgmt_ioc_get_fw' 151 + in this case. The 'major' and 'minor' fields are set by the kernel in 152 + response. 152 153 153 154 3. FW_MGMT_IOC_INTF_LOAD_AND_VALIDATE: 154 155 155 - This ioctl shall be used the user to load an Interface Firmware package on an 156 - Interface. The user needs to fill the 'firmware_tag' and 'load_method' fields 157 - of the 'struct fw_mgmt_ioc_intf_load_and_validate'. The 'status', 'major' and 158 - 'minor' fields are set by the kernel in response. 156 + This ioctl shall be used by the user to load an Interface Firmware package on 157 + an Interface. The user needs to fill the 'firmware_tag' and 'load_method' 158 + fields of the 'struct fw_mgmt_ioc_intf_load_and_validate'. The 'status', 159 + 'major' and 'minor' fields are set by the kernel in response. 159 160 160 161 4. FW_MGMT_IOC_INTF_BACKEND_FW_UPDATE: 161 162 162 - This ioctl shall be used the user to request an Interface to update a Backend 163 - Interface Firmware. The user is required to fill the 'firmware_tag' field of 164 - the 'struct fw_mgmt_ioc_get_fw' in this case. The 'status' field is set by 165 - the kernel in response. 163 + This ioctl shall be used by the user to request an Interface to update a 164 + Backend Interface Firmware. The user is required to fill the 'firmware_tag' 165 + field of the 'struct fw_mgmt_ioc_get_fw' in this case. The 'status' field is 166 + set by the kernel in response. 166 167 167 168 5. FW_MGMT_IOC_SET_TIMEOUT_MS: 168 169 169 - This ioctl shall be used the user to increase the timeout interval within 170 + This ioctl shall be used by the user to increase the timeout interval within 170 171 which the firmware must get loaded by the Module. The default timeout is 1 171 172 second. The user needs to pass the timeout in milliseconds. 172 173 173 174 6. FW_MGMT_IOC_MODE_SWITCH: 174 175 175 - This ioctl shall be used the user to mode-switch the module to the previously 176 - loaded interface firmware. If the interface firmware isn't loaded previously, 177 - or if another unsuccessful FW_MGMT_IOC_INTF_LOAD_AND_VALIDATE operation is 178 - started after loading interface firmware, then the firmware core wouldn't 179 - allow mode-switch. 176 + This ioctl shall be used by the user to mode-switch the module to the 177 + previously loaded interface firmware. If the interface firmware isn't loaded 178 + previously, or if another unsuccessful FW_MGMT_IOC_INTF_LOAD_AND_VALIDATE 179 + operation is started after loading interface firmware, then the firmware core 180 + wouldn't allow mode-switch. 180 181 181 182 182 183 Sysfs Interfaces - Authentication ··· 280 279 281 280 1. CAP_IOC_GET_ENDPOINT_UID: 282 281 283 - This ioctl shall be used the user to get the endpoint UID associated with the 284 - Interface. All the fields of the 'struct cap_ioc_get_endpoint_uid' are 282 + This ioctl shall be used by the user to get the endpoint UID associated with 283 + the Interface. All the fields of the 'struct cap_ioc_get_endpoint_uid' are 285 284 filled by the kernel. 286 285 287 286 2. CAP_IOC_GET_IMS_CERTIFICATE: 288 287 289 - This ioctl shall be used the user to retrieve one of the available 288 + This ioctl shall be used by the user to retrieve one of the available 290 289 cryptographic certificates held by the Interface for use in Component 291 290 Authentication. The user is required to fill the 'certificate_class' and 292 291 'certificate_id' field of the 'struct cap_ioc_get_ims_certificate' in this ··· 296 295 297 296 3. CAP_IOC_AUTHENTICATE: 298 297 299 - This ioctl shall be used the user to authenticate the Module attached to an 300 - Interface. The user needs to fill the 'auth_type', 'uid', and 'challenge' 298 + This ioctl shall be used by the user to authenticate the Module attached to 299 + an Interface. The user needs to fill the 'auth_type', 'uid', and 'challenge' 301 300 fields of the 'struct cap_ioc_authenticate'. The other fields will be set by 302 301 the kernel in response. The first 'signature_size' bytes of the 'signature' 303 302 shall be read by the user and others must be discarded.