149 lines
4.9 KiB
C
149 lines
4.9 KiB
C
/* arduino-hid.c - subdriver to monitor Arduino USB/HID devices with NUT
|
|
*
|
|
* Copyright (C)
|
|
* 2003 - 2012 Arnaud Quette <ArnaudQuette@Eaton.com>
|
|
* 2005 - 2006 Peter Selinger <selinger@users.sourceforge.net>
|
|
* 2008 - 2009 Arjen de Korte <adkorte-guest@alioth.debian.org>
|
|
* 2013 Charles Lepple <clepple+nut@gmail.com>
|
|
* 2021 Alex Bratchik <alexbratchik@yandex.com>
|
|
*
|
|
* Note: this subdriver was initially generated as a "stub" by the
|
|
* gen-usbhid-subdriver script. It must be customized.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*/
|
|
|
|
#include "config.h" /* must be first */
|
|
|
|
#include "usbhid-ups.h"
|
|
#include "arduino-hid.h"
|
|
#include "main.h" /* for getval() */
|
|
#include "usb-common.h"
|
|
|
|
#define ARDUINO_HID_VERSION "Arduino HID 0.2"
|
|
/* FIXME: experimental flag to be put in upsdrv_info */
|
|
|
|
/* Arduino */
|
|
#define ARDUINO_VENDORID 0x2341
|
|
#define ARDUINO_VENDORID2 0x2A03
|
|
|
|
/* USB IDs device table */
|
|
static usb_device_id_t arduino_usb_device_table[] = {
|
|
/* Arduino Leonardo, Leonardo ETH and Pro Micro*/
|
|
{ USB_DEVICE(ARDUINO_VENDORID, 0x0036), NULL },
|
|
{ USB_DEVICE(ARDUINO_VENDORID, 0x8036), NULL },
|
|
{ USB_DEVICE(ARDUINO_VENDORID2, 0x0036), NULL },
|
|
{ USB_DEVICE(ARDUINO_VENDORID2, 0x8036), NULL },
|
|
{ USB_DEVICE(ARDUINO_VENDORID2, 0x0040), NULL },
|
|
{ USB_DEVICE(ARDUINO_VENDORID2, 0x8040), NULL },
|
|
|
|
/* Terminating entry */
|
|
{ 0, 0, NULL }
|
|
};
|
|
|
|
static usb_communication_subdriver_t *usb = &usb_subdriver;
|
|
|
|
|
|
/* --------------------------------------------------------------- */
|
|
/* Vendor-specific usage table */
|
|
/* --------------------------------------------------------------- */
|
|
|
|
/* ARDUINO usage table */
|
|
static usage_lkp_t arduino_usage_lkp[] = {
|
|
{ NULL, 0 }
|
|
};
|
|
|
|
static usage_tables_t arduino_utab[] = {
|
|
arduino_usage_lkp,
|
|
hid_usage_lkp,
|
|
NULL,
|
|
};
|
|
|
|
/* --------------------------------------------------------------- */
|
|
/* HID2NUT lookup table */
|
|
/* --------------------------------------------------------------- */
|
|
|
|
static hid_info_t arduino_hid2nut[] = {
|
|
|
|
/* USB HID PDC defaults */
|
|
{ "ups.delay.start", ST_FLAG_RW | ST_FLAG_STRING, 10, "UPS.PowerSummary.DelayBeforeStartup", NULL, DEFAULT_ONDELAY, HU_FLAG_ABSENT, NULL},
|
|
{ "ups.delay.shutdown", ST_FLAG_RW | ST_FLAG_STRING, 10, "UPS.PowerSummary.DelayBeforeShutdown", NULL, DEFAULT_OFFDELAY, HU_FLAG_ABSENT, NULL},
|
|
{ "ups.timer.start", 0, 0, "UPS.PowerSummary.DelayBeforeStartup", NULL, "%.0f", HU_FLAG_QUICK_POLL, NULL},
|
|
{ "ups.timer.shutdown", 0, 0, "UPS.PowerSummary.DelayBeforeShutdown", NULL, "%.0f", HU_FLAG_QUICK_POLL, NULL},
|
|
{ "ups.timer.reboot", 0, 0, "UPS.PowerSummary.DelayBeforeReboot", NULL, "%.0f", HU_FLAG_QUICK_POLL, NULL},
|
|
|
|
/* USB HID PDC defaults */
|
|
{ "load.off.delay", 0, 0, "UPS.PowerSummary.DelayBeforeShutdown", NULL, DEFAULT_OFFDELAY, HU_TYPE_CMD, NULL },
|
|
{ "load.on.delay", 0, 0, "UPS.PowerSummary.DelayBeforeStartup", NULL, DEFAULT_ONDELAY, HU_TYPE_CMD, NULL },
|
|
{ "shutdown.stop", 0, 0, "UPS.PowerSummary.DelayBeforeShutdown", NULL, "-1", HU_TYPE_CMD, NULL },
|
|
{ "shutdown.reboot", 0, 0, "UPS.PowerSummary.DelayBeforeReboot", NULL, "10", HU_TYPE_CMD, NULL },
|
|
|
|
/* end of structure. */
|
|
{ NULL, 0, 0, NULL, NULL, NULL, 0, NULL }
|
|
};
|
|
|
|
static const char *arduino_format_model(HIDDevice_t *hd) {
|
|
return hd->Product;
|
|
}
|
|
|
|
static const char *arduino_format_mfr(HIDDevice_t *hd) {
|
|
return hd->Vendor ? hd->Vendor : "Arduino";
|
|
}
|
|
|
|
static const char *arduino_format_serial(HIDDevice_t *hd) {
|
|
return hd->Serial;
|
|
}
|
|
|
|
/* this function allows the subdriver to "claim" a device: return 1 if
|
|
* the device is supported by this subdriver, else 0. */
|
|
static int arduino_claim(HIDDevice_t *hd)
|
|
{
|
|
int status = is_usb_device_supported(arduino_usb_device_table, hd);
|
|
|
|
switch (status) {
|
|
case POSSIBLY_SUPPORTED:
|
|
/* by default, reject, unless the productid option is given */
|
|
if (getval("productid")) {
|
|
usb->hid_ep_in=4;
|
|
usb->hid_ep_out=5;
|
|
usb->hid_rep_index = 2;
|
|
return 1;
|
|
}
|
|
possibly_supported("Arduino", hd);
|
|
return 0;
|
|
|
|
case SUPPORTED:
|
|
usb->hid_ep_in=4;
|
|
usb->hid_ep_out=5;
|
|
usb->hid_rep_index = 2;
|
|
return 1;
|
|
|
|
case NOT_SUPPORTED:
|
|
default:
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
subdriver_t arduino_subdriver = {
|
|
ARDUINO_HID_VERSION,
|
|
arduino_claim,
|
|
arduino_utab,
|
|
arduino_hid2nut,
|
|
arduino_format_model,
|
|
arduino_format_mfr,
|
|
arduino_format_serial,
|
|
fix_report_desc,
|
|
};
|