1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/sys/include/usb_board_reset_internal.h
chrysn a787875cf8 usb_board_reset: Split headers into public and private
The private parts need USB definitions (and are thus preferably used
from USB_H_USER_IS_RIOT_INTERNAL compilation units). Functions like
usb_board_reset_in_bootloader do not depend on USB headers for their
definitions and are fair game throughout the application even for
generic RIOT USB devices.
2020-07-01 13:22:25 +02:00

52 lines
1.3 KiB
C

/*
* Copyright (C) 2020 Inria
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup sys_usb_board_reset_internal Board reset via USB CDC ACM internals
* @ingroup sys_usb_board_reset
* @brief Callbacks provided by the USB_BOARD_RESET to the ACM subsystem
*
* @{
*
* @file
* @author Alexandre Abadie <alexandre.abadie@inria.fr>
*/
#ifndef USB_BOARD_RESET_INTERNAL_H
#define USB_BOARD_RESET_INTERNAL_H
#ifdef __cplusplus
extern "C" {
#endif
#include <inttypes.h>
#include "usb/usbus/cdc/acm.h"
/**
* @brief USB coding callback used to trigger the board reset
*
* @param[in] cdcacm Pointer to the cdcacm device
* @param[in] baud Baudrate used by the client. Only 1200 baud is taken into account
* @param[in] bits Number of bit mode used by the client
* @param[in] parity Parity mode used by the client
* @param[in] stop Stop bit mode used by the client
*
* @return Always return 0
*/
int usb_board_reset_coding_cb(usbus_cdcacm_device_t *cdcacm,
uint32_t baud, uint8_t bits,
uint8_t parity, uint8_t stop);
#ifdef __cplusplus
}
#endif
#endif /* USB_BOARD_RESET_INTERNAL_H */
/** @} */