mirror of
https://github.com/licsber/micropython.git
synced 2024-09-20 17:10:24 +08:00
299bc62586
The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_*.h * qstrdefs*.h
46 lines
1.7 KiB
C
46 lines
1.7 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*/
|
|
#ifndef MICROPY_INCLUDED_STMHAL_USBD_CDC_INTERFACE_H
|
|
#define MICROPY_INCLUDED_STMHAL_USBD_CDC_INTERFACE_H
|
|
|
|
/**
|
|
******************************************************************************
|
|
* @file USB_Device/CDC_Standalone/Inc/usbd_cdc_interface.h
|
|
* @author MCD Application Team
|
|
* @version V1.0.1
|
|
* @date 26-February-2014
|
|
* @brief Header for usbd_cdc_interface.c file.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
|
|
*
|
|
* Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");
|
|
* You may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at:
|
|
*
|
|
* http://www.st.com/software_license_agreement_liberty_v2
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
extern const USBD_CDC_ItfTypeDef USBD_CDC_fops;
|
|
|
|
int USBD_CDC_IsConnected(void);
|
|
|
|
int USBD_CDC_TxHalfEmpty(void);
|
|
int USBD_CDC_Tx(const uint8_t *buf, uint32_t len, uint32_t timeout);
|
|
void USBD_CDC_TxAlways(const uint8_t *buf, uint32_t len);
|
|
|
|
int USBD_CDC_RxNum(void);
|
|
int USBD_CDC_Rx(uint8_t *buf, uint32_t len, uint32_t timeout);
|
|
|
|
#endif // MICROPY_INCLUDED_STMHAL_USBD_CDC_INTERFACE_H
|