1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2015 Daniel Campora
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 #ifndef MICROPY_INCLUDED_LIB_UTILS_MPIRQ_H
27 #define MICROPY_INCLUDED_LIB_UTILS_MPIRQ_H
28 
29 #include "py/runtime.h"
30 
31 /******************************************************************************
32  DEFINE CONSTANTS
33  ******************************************************************************/
34 
35 enum {
36     MP_IRQ_ARG_INIT_handler = 0,
37     MP_IRQ_ARG_INIT_trigger,
38     MP_IRQ_ARG_INIT_hard,
39     MP_IRQ_ARG_INIT_NUM_ARGS,
40 };
41 
42 /******************************************************************************
43  DEFINE TYPES
44  ******************************************************************************/
45 
46 typedef mp_uint_t (*mp_irq_trigger_fun_t)(mp_obj_t self, mp_uint_t trigger);
47 typedef mp_uint_t (*mp_irq_info_fun_t)(mp_obj_t self, mp_uint_t info_type);
48 
49 enum {
50     MP_IRQ_INFO_FLAGS,
51     MP_IRQ_INFO_TRIGGERS,
52 };
53 
54 typedef struct _mp_irq_methods_t {
55     mp_irq_trigger_fun_t trigger;
56     mp_irq_info_fun_t info;
57 } mp_irq_methods_t;
58 
59 typedef struct _mp_irq_obj_t {
60     mp_obj_base_t base;
61     mp_irq_methods_t *methods;
62     mp_obj_t parent;
63     mp_obj_t handler;
64     bool ishard;
65 } mp_irq_obj_t;
66 
67 /******************************************************************************
68  DECLARE EXPORTED DATA
69  ******************************************************************************/
70 
71 extern const mp_arg_t mp_irq_init_args[];
72 extern const mp_obj_type_t mp_irq_type;
73 
74 /******************************************************************************
75  DECLARE PUBLIC FUNCTIONS
76  ******************************************************************************/
77 
78 mp_irq_obj_t *mp_irq_new(const mp_irq_methods_t *methods, mp_obj_t parent);
79 void mp_irq_init(mp_irq_obj_t *self, const mp_irq_methods_t *methods, mp_obj_t parent);
80 void mp_irq_handler(mp_irq_obj_t *self);
81 
82 #endif // MICROPY_INCLUDED_LIB_UTILS_MPIRQ_H
83