fwupd/libdfu/dfu-target.h
Richard Hughes b28daac301 libdfu: Use a heuristic for the start address if the firmware has no DfuSe footer
This fixes flashing into the 96Boards BLE Carbon.
2016-11-03 15:11:25 +00:00

104 lines
3.8 KiB
C

/* -*- 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_TARGET_H
#define __DFU_TARGET_H
#include <glib-object.h>
#include <gio/gio.h>
#include <gusb.h>
#include "dfu-common.h"
#include "dfu-image.h"
G_BEGIN_DECLS
#define DFU_TYPE_TARGET (dfu_target_get_type ())
G_DECLARE_DERIVABLE_TYPE (DfuTarget, dfu_target, DFU, TARGET, GUsbDevice)
struct _DfuTargetClass
{
GUsbDeviceClass parent_class;
void (*percentage_changed) (DfuTarget *target,
guint percentage);
void (*action_changed) (DfuTarget *target,
DfuAction action);
/*< private >*/
/* Padding for future expansion */
void (*_dfu_target_reserved1) (void);
void (*_dfu_target_reserved2) (void);
void (*_dfu_target_reserved3) (void);
void (*_dfu_target_reserved4) (void);
void (*_dfu_target_reserved5) (void);
void (*_dfu_target_reserved6) (void);
void (*_dfu_target_reserved7) (void);
void (*_dfu_target_reserved8) (void);
};
/**
* DfuTargetTransferFlags:
* @DFU_TARGET_TRANSFER_FLAG_NONE: No flags set
* @DFU_TARGET_TRANSFER_FLAG_VERIFY: Verify the download once complete
* @DFU_TARGET_TRANSFER_FLAG_DETACH: If required, detach from runtime mode
* @DFU_TARGET_TRANSFER_FLAG_ATTACH: Attach the device back to runtime after completion
* @DFU_TARGET_TRANSFER_FLAG_WAIT_RUNTIME: Wait for runtime to load after completion
* @DFU_TARGET_TRANSFER_FLAG_WILDCARD_VID: Allow downloading images with wildcard VIDs
* @DFU_TARGET_TRANSFER_FLAG_WILDCARD_PID: Allow downloading images with wildcard PIDs
* @DFU_TARGET_TRANSFER_FLAG_ANY_CIPHER: Allow any cipher kinds to be downloaded
* @DFU_TARGET_TRANSFER_FLAG_ADDR_HEURISTIC: Automatically detect the address to use
*
* The optional flags used for transfering firmware.
**/
typedef enum {
DFU_TARGET_TRANSFER_FLAG_NONE = 0,
DFU_TARGET_TRANSFER_FLAG_VERIFY = (1 << 0),
DFU_TARGET_TRANSFER_FLAG_DETACH = (1 << 1),
DFU_TARGET_TRANSFER_FLAG_ATTACH = (1 << 2),
DFU_TARGET_TRANSFER_FLAG_WAIT_RUNTIME = (1 << 3),
DFU_TARGET_TRANSFER_FLAG_WILDCARD_VID = (1 << 4),
DFU_TARGET_TRANSFER_FLAG_WILDCARD_PID = (1 << 5),
DFU_TARGET_TRANSFER_FLAG_ANY_CIPHER = (1 << 6),
DFU_TARGET_TRANSFER_FLAG_ADDR_HEURISTIC = (1 << 7),
/*< private >*/
DFU_TARGET_TRANSFER_FLAG_LAST
} DfuTargetTransferFlags;
GPtrArray *dfu_target_get_sectors (DfuTarget *target);
guint8 dfu_target_get_alt_setting (DfuTarget *target);
const gchar *dfu_target_get_alt_name (DfuTarget *target,
GError **error);
const gchar *dfu_target_get_alt_name_for_display (DfuTarget *target,
GError **error);
DfuImage *dfu_target_upload (DfuTarget *target,
DfuTargetTransferFlags flags,
GCancellable *cancellable,
GError **error);
gboolean dfu_target_download (DfuTarget *target,
DfuImage *image,
DfuTargetTransferFlags flags,
GCancellable *cancellable,
GError **error);
DfuCipherKind dfu_target_get_cipher_kind (DfuTarget *target);
G_END_DECLS
#endif /* __DFU_TARGET_H */