pios_usbhook.h

Go to the documentation of this file.

/*
 * 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 3 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, see <http://www.gnu.org/licenses/>
 */

#ifndef PIOS_USBHOOK_H
#define PIOS_USBHOOK_H

#include <stdbool.h>
#include <stdint.h>
#include "pios_usb_defs.h"      /* usb_setup_request */

struct pios_usbhook_descriptor {
        const uint8_t * descriptor;
        uint16_t length;
};

enum usb_string_desc {
        USB_STRING_DESC_LANG    = 0,
        USB_STRING_DESC_VENDOR  = 1,
        USB_STRING_DESC_PRODUCT = 2,
        USB_STRING_DESC_SERIAL  = 3,
} __attribute__((packed));

extern void PIOS_USBHOOK_RegisterDevice(const uint8_t * desc, uint16_t desc_size);
extern void PIOS_USBHOOK_RegisterConfig(uint8_t config_id, const uint8_t * desc, uint16_t desc_size);
extern void PIOS_USBHOOK_RegisterString(enum usb_string_desc string_id, const uint8_t * desc, uint16_t desc_size);

struct pios_usb_ifops {
  void (*init)(uintptr_t context);
  void (*deinit)(uintptr_t context);
  bool (*setup)(uintptr_t context, struct usb_setup_request * req);
  void (*ctrl_data_out)(uintptr_t context, const struct usb_setup_request * req);
};

extern void PIOS_USBHOOK_RegisterIfOps(uint8_t ifnum, struct pios_usb_ifops * ifops, uintptr_t context);

typedef bool (*pios_usbhook_epcb)(uintptr_t context, uint8_t epnum, uint16_t len);

extern void PIOS_USBHOOK_RegisterEpInCallback(uint8_t epnum, uint16_t max_len, pios_usbhook_epcb cb, uintptr_t context);
extern void PIOS_USBHOOK_RegisterEpOutCallback(uint8_t epnum, uint16_t max_len, pios_usbhook_epcb cb, uintptr_t context);
extern void PIOS_USBHOOK_DeRegisterEpInCallback(uint8_t epnum);
extern void PIOS_USBHOOK_DeRegisterEpOutCallback(uint8_t epnum);

extern void PIOS_USBHOOK_CtrlTx(const uint8_t *buf, uint16_t len);
extern void PIOS_USBHOOK_CtrlRx(uint8_t *buf, uint16_t len);
extern void PIOS_USBHOOK_EndpointTx(uint8_t epnum, const uint8_t *buf, uint16_t len);
extern void PIOS_USBHOOK_EndpointRx(uint8_t epnum, uint8_t *buf, uint16_t len);
extern void PIOS_USBHOOK_Activate(void);
extern void PIOS_USBHOOK_Deactivate(void);

#endif /* PIOS_USBHOOK_H */