/usr/include/libdfu/dfu-common.h is in libdfu-dev 0.7.0-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2015 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __DFU_COMMON_H
#define __DFU_COMMON_H
#include <glib.h>
#include <gusb.h>
G_BEGIN_DECLS
/**
* DfuRequest:
* @DFU_REQUEST_DETACH: Detach
* @DFU_REQUEST_DNLOAD: Download host-to-device
* @DFU_REQUEST_UPLOAD: Upload device-to-host
* @DFU_REQUEST_GETSTATUS: Get the device status
* @DFU_REQUEST_CLRSTATUS: Clear the device status
* @DFU_REQUEST_GETSTATE: Get the last set state
* @DFU_REQUEST_ABORT: Abort the current transfer
*
* The DFU request kinds.
**/
typedef enum {
DFU_REQUEST_DETACH = 0x00,
DFU_REQUEST_DNLOAD = 0x01,
DFU_REQUEST_UPLOAD = 0x02,
DFU_REQUEST_GETSTATUS = 0x03,
DFU_REQUEST_CLRSTATUS = 0x04,
DFU_REQUEST_GETSTATE = 0x05,
DFU_REQUEST_ABORT = 0x06,
/*< private >*/
DFU_REQUEST_LAST
} DfuRequest;
/**
* DfuStatus:
* @DFU_STATUS_OK: No error condition is present
* @DFU_STATUS_ERR_TARGET: File is not targeted for use by this device
* @DFU_STATUS_ERR_FILE: File is for this device but fails a verification test
* @DFU_STATUS_ERR_WRITE: Device is unable to write memory
* @DFU_STATUS_ERR_ERASE: Memory erase function failed
* @DFU_STATUS_ERR_CHECK_ERASED: Memory erase check failed
* @DFU_STATUS_ERR_PROG: Program memory function failed
* @DFU_STATUS_ERR_VERIFY: Programmed memory failed verification
* @DFU_STATUS_ERR_ADDRESS: Cannot program memory due to received address that isout of range
* @DFU_STATUS_ERR_NOTDONE: Received DFU_DNLOAD with wLength = 0 but data is incomplete
* @DFU_STATUS_ERR_FIRMWARE: Device firmware is corrupt
* @DFU_STATUS_ERR_VENDOR: iString indicates a vendor-specific error
* @DFU_STATUS_ERR_USBR: Device detected unexpected USB reset signaling
* @DFU_STATUS_ERR_POR: Device detected unexpected power on reset
* @DFU_STATUS_ERR_UNKNOWN: Something unexpected went wrong
* @DFU_STATUS_ERR_STALLDPKT: Device stalled an unexpected request
*
* The status enumerated kind.
**/
typedef enum {
DFU_STATUS_OK = 0x00,
DFU_STATUS_ERR_TARGET = 0x01,
DFU_STATUS_ERR_FILE = 0x02,
DFU_STATUS_ERR_WRITE = 0x03,
DFU_STATUS_ERR_ERASE = 0x04,
DFU_STATUS_ERR_CHECK_ERASED = 0x05,
DFU_STATUS_ERR_PROG = 0x06,
DFU_STATUS_ERR_VERIFY = 0x07,
DFU_STATUS_ERR_ADDRESS = 0x08,
DFU_STATUS_ERR_NOTDONE = 0x09,
DFU_STATUS_ERR_FIRMWARE = 0x0a,
DFU_STATUS_ERR_VENDOR = 0x0b,
DFU_STATUS_ERR_USBR = 0x0c,
DFU_STATUS_ERR_POR = 0x0d,
DFU_STATUS_ERR_UNKNOWN = 0x0e,
DFU_STATUS_ERR_STALLDPKT = 0x0f,
/*< private >*/
DFU_STATUS_LAST
} DfuStatus;
/**
* DfuState:
* @DFU_STATE_APP_IDLE: State 0
* @DFU_STATE_APP_DETACH: State 1
* @DFU_STATE_DFU_IDLE: State 2
* @DFU_STATE_DFU_DNLOAD_SYNC: State 3
* @DFU_STATE_DFU_DNBUSY: State 4
* @DFU_STATE_DFU_DNLOAD_IDLE: State 5
* @DFU_STATE_DFU_MANIFEST_SYNC: State 6
* @DFU_STATE_DFU_MANIFEST: State 7
* @DFU_STATE_DFU_MANIFEST_WAIT_RESET: State 8
* @DFU_STATE_DFU_UPLOAD_IDLE: State 9
* @DFU_STATE_DFU_ERROR: State 10
*
* The state enumerated kind.
**/
typedef enum {
DFU_STATE_APP_IDLE = 0x00,
DFU_STATE_APP_DETACH = 0x01,
DFU_STATE_DFU_IDLE = 0x02,
DFU_STATE_DFU_DNLOAD_SYNC = 0x03,
DFU_STATE_DFU_DNBUSY = 0x04,
DFU_STATE_DFU_DNLOAD_IDLE = 0x05,
DFU_STATE_DFU_MANIFEST_SYNC = 0x06,
DFU_STATE_DFU_MANIFEST = 0x07,
DFU_STATE_DFU_MANIFEST_WAIT_RESET = 0x08,
DFU_STATE_DFU_UPLOAD_IDLE = 0x09,
DFU_STATE_DFU_ERROR = 0x0a,
/*< private >*/
DFU_STATE_LAST
} DfuState;
/**
* DfuMode:
* @DFU_MODE_UNKNOWN: Unknown mode
* @DFU_MODE_RUNTIME: Runtime mode
* @DFU_MODE_DFU: Bootloader mode
*
* The mode enumerated kind.
**/
typedef enum {
DFU_MODE_UNKNOWN,
DFU_MODE_RUNTIME,
DFU_MODE_DFU,
/*< private >*/
DFU_MODE_LAST
} DfuMode;
/**
* DfuCipherKind:
* @DFU_CIPHER_KIND_NONE: No cipher detected
* @DFU_CIPHER_KIND_XTEA: XTEA cipher detected
*
* The type of cipher used for transfering the firmware.
**/
typedef enum {
DFU_CIPHER_KIND_NONE,
DFU_CIPHER_KIND_XTEA,
/*< private >*/
DFU_CIPHER_KIND_LAST
} DfuCipherKind;
#define DFU_METADATA_KEY_LICENSE "License"
#define DFU_METADATA_KEY_COPYRIGHT "Copyright"
#define DFU_METADATA_KEY_CIPHER_KIND "CipherKind"
const gchar *dfu_state_to_string (DfuState state);
const gchar *dfu_status_to_string (DfuStatus status);
const gchar *dfu_mode_to_string (DfuMode mode);
const gchar *dfu_cipher_kind_to_string (DfuCipherKind cipher_kind);
G_END_DECLS
#endif /* __DFU_COMMON_H */
|