mirror of
https://github.com/licsber/micropython.git
synced 2024-09-21 09:30: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
75 lines
3.0 KiB
C
75 lines
3.0 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2015 Daniel Campora
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
#ifndef MICROPY_INCLUDED_CC3200_MISC_MPIRQ_H
|
|
#define MICROPY_INCLUDED_CC3200_MISC_MPIRQ_H
|
|
|
|
/******************************************************************************
|
|
DEFINE CONSTANTS
|
|
******************************************************************************/
|
|
#define mp_irq_INIT_NUM_ARGS 4
|
|
|
|
/******************************************************************************
|
|
DEFINE TYPES
|
|
******************************************************************************/
|
|
typedef mp_obj_t (*mp_irq_init_t) (mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args);
|
|
typedef void (*mp_irq_void_method_t) (mp_obj_t self);
|
|
typedef int (*mp_irq_int_method_t) (mp_obj_t self);
|
|
|
|
typedef struct {
|
|
mp_irq_init_t init;
|
|
mp_irq_void_method_t enable;
|
|
mp_irq_void_method_t disable;
|
|
mp_irq_int_method_t flags;
|
|
} mp_irq_methods_t;
|
|
|
|
typedef struct {
|
|
mp_obj_base_t base;
|
|
mp_obj_t parent;
|
|
mp_obj_t handler;
|
|
mp_irq_methods_t *methods;
|
|
bool isenabled;
|
|
} mp_irq_obj_t;
|
|
|
|
/******************************************************************************
|
|
DECLARE EXPORTED DATA
|
|
******************************************************************************/
|
|
extern const mp_arg_t mp_irq_init_args[];
|
|
extern const mp_obj_type_t mp_irq_type;
|
|
|
|
/******************************************************************************
|
|
DECLARE PUBLIC FUNCTIONS
|
|
******************************************************************************/
|
|
void mp_irq_init0 (void);
|
|
mp_obj_t mp_irq_new (mp_obj_t parent, mp_obj_t handler, const mp_irq_methods_t *methods);
|
|
mp_irq_obj_t *mp_irq_find (mp_obj_t parent);
|
|
void mp_irq_wake_all (void);
|
|
void mp_irq_disable_all (void);
|
|
void mp_irq_remove (const mp_obj_t parent);
|
|
void mp_irq_handler (mp_obj_t self_in);
|
|
uint mp_irq_translate_priority (uint priority);
|
|
|
|
#endif // MICROPY_INCLUDED_CC3200_MISC_MPIRQ_H
|