fwupd/libfwupdplugin/fu-hid-device.h
2021-08-24 11:18:40 -05:00

67 lines
1.9 KiB
C

/*
* Copyright (C) 2017 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#pragma once
#include <glib-object.h>
#include "fu-usb-device.h"
#define FU_TYPE_HID_DEVICE (fu_hid_device_get_type())
G_DECLARE_DERIVABLE_TYPE(FuHidDevice, fu_hid_device, FU, HID_DEVICE, FuUsbDevice)
struct _FuHidDeviceClass {
FuUsbDeviceClass parent_class;
gpointer __reserved[31];
};
/**
* FuHidDeviceFlags:
* @FU_HID_DEVICE_FLAG_NONE: No flags set
* @FU_HID_DEVICE_FLAG_ALLOW_TRUNC: Allow truncated reads and writes
* @FU_HID_DEVICE_FLAG_IS_FEATURE: Use %FU_HID_REPORT_TYPE_FEATURE for wValue
* @FU_HID_DEVICE_FLAG_RETRY_FAILURE: Retry up to 10 times on failure
* @FU_HID_DEVICE_FLAG_NO_KERNEL_UNBIND: Do not unbind the kernel driver on open
* @FU_HID_DEVICE_FLAG_NO_KERNEL_REBIND: Do not rebind the kernel driver on close
*
* Flags used when calling fu_hid_device_get_report() and fu_hid_device_set_report().
**/
typedef enum {
FU_HID_DEVICE_FLAG_NONE = 0,
FU_HID_DEVICE_FLAG_ALLOW_TRUNC = 1 << 0,
FU_HID_DEVICE_FLAG_IS_FEATURE = 1 << 1,
FU_HID_DEVICE_FLAG_RETRY_FAILURE = 1 << 2,
FU_HID_DEVICE_FLAG_NO_KERNEL_UNBIND = 1 << 3,
FU_HID_DEVICE_FLAG_NO_KERNEL_REBIND = 1 << 4,
/*< private >*/
FU_HID_DEVICE_FLAG_LAST
} FuHidDeviceFlags;
FuHidDevice *
fu_hid_device_new(GUsbDevice *usb_device);
void
fu_hid_device_add_flag(FuHidDevice *self, FuHidDeviceFlags flag);
void
fu_hid_device_set_interface(FuHidDevice *self, guint8 interface);
guint8
fu_hid_device_get_interface(FuHidDevice *self);
gboolean
fu_hid_device_set_report(FuHidDevice *self,
guint8 value,
guint8 *buf,
gsize bufsz,
guint timeout,
FuHidDeviceFlags flags,
GError **error) G_GNUC_WARN_UNUSED_RESULT;
gboolean
fu_hid_device_get_report(FuHidDevice *self,
guint8 value,
guint8 *buf,
gsize bufsz,
guint timeout,
FuHidDeviceFlags flags,
GError **error) G_GNUC_WARN_UNUSED_RESULT;