LCOV - code coverage report
Current view: top level - extmod - machine_signal.c (source / functions) Hit Total Coverage
Test: unix_coverage_v1.22.2.info Lines: 35 38 92.1 %
Date: 2024-02-22 17:11:03 Functions: 6 6 100.0 %
Branches: 9 13 69.2 %

           Branch data     Line data    Source code
       1                 :            : /*
       2                 :            :  * This file is part of the MicroPython project, http://micropython.org/
       3                 :            :  *
       4                 :            :  * The MIT License (MIT)
       5                 :            :  *
       6                 :            :  * Copyright (c) 2017 Paul Sokolovsky
       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                 :            : 
      27                 :            : #include "py/mpconfig.h"
      28                 :            : #if MICROPY_PY_MACHINE
      29                 :            : 
      30                 :            : #include <string.h>
      31                 :            : 
      32                 :            : #include "py/runtime.h"
      33                 :            : #include "extmod/modmachine.h"
      34                 :            : #include "extmod/virtpin.h"
      35                 :            : 
      36                 :            : // Signal class
      37                 :            : 
      38                 :            : typedef struct _machine_signal_t {
      39                 :            :     mp_obj_base_t base;
      40                 :            :     mp_obj_t pin;
      41                 :            :     bool invert;
      42                 :            : } machine_signal_t;
      43                 :            : 
      44                 :          8 : STATIC mp_obj_t signal_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
      45                 :          8 :     mp_obj_t pin;
      46                 :          8 :     bool invert = false;
      47                 :            : 
      48                 :            :     #if defined(MICROPY_PY_MACHINE_PIN_MAKE_NEW)
      49                 :            :     mp_pin_p_t *pin_p = NULL;
      50                 :            : 
      51                 :            :     if (n_args > 0 && mp_obj_is_obj(args[0])) {
      52                 :            :         mp_obj_base_t *pin_base = (mp_obj_base_t *)MP_OBJ_TO_PTR(args[0]);
      53                 :            :         pin_p = (mp_pin_p_t *)MP_OBJ_TYPE_GET_SLOT_OR_NULL(pin_base->type, protocol);
      54                 :            :     }
      55                 :            : 
      56                 :            :     if (pin_p == NULL) {
      57                 :            :         // If first argument isn't a Pin-like object, we filter out "invert"
      58                 :            :         // from keyword arguments and pass them all to the exported Pin
      59                 :            :         // constructor to create one.
      60                 :            :         mp_obj_t *pin_args = mp_local_alloc((n_args + n_kw * 2) * sizeof(mp_obj_t));
      61                 :            :         memcpy(pin_args, args, n_args * sizeof(mp_obj_t));
      62                 :            :         const mp_obj_t *src = args + n_args;
      63                 :            :         mp_obj_t *dst = pin_args + n_args;
      64                 :            :         mp_obj_t *sig_value = NULL;
      65                 :            :         for (size_t cnt = n_kw; cnt; cnt--) {
      66                 :            :             if (*src == MP_OBJ_NEW_QSTR(MP_QSTR_invert)) {
      67                 :            :                 invert = mp_obj_is_true(src[1]);
      68                 :            :                 n_kw--;
      69                 :            :             } else {
      70                 :            :                 *dst++ = *src;
      71                 :            :                 *dst++ = src[1];
      72                 :            :             }
      73                 :            :             if (*src == MP_OBJ_NEW_QSTR(MP_QSTR_value)) {
      74                 :            :                 // Value is pertained to Signal, so we should invert
      75                 :            :                 // it for Pin if needed, and we should do it only when
      76                 :            :                 // inversion status is guaranteedly known.
      77                 :            :                 sig_value = dst - 1;
      78                 :            :             }
      79                 :            :             src += 2;
      80                 :            :         }
      81                 :            : 
      82                 :            :         if (invert && sig_value != NULL) {
      83                 :            :             *sig_value = mp_obj_is_true(*sig_value) ? MP_OBJ_NEW_SMALL_INT(0) : MP_OBJ_NEW_SMALL_INT(1);
      84                 :            :         }
      85                 :            : 
      86                 :            :         // Here we pass NULL as a type, hoping that mp_pin_make_new()
      87                 :            :         // will just ignore it as set a concrete type. If not, we'd need
      88                 :            :         // to expose port's "default" pin type too.
      89                 :            :         pin = MICROPY_PY_MACHINE_PIN_MAKE_NEW(NULL, n_args, n_kw, pin_args);
      90                 :            : 
      91                 :            :         mp_local_free(pin_args);
      92                 :            :     } else
      93                 :            :     #endif
      94                 :            :     // Otherwise there should be 1 or 2 args
      95                 :            :     {
      96         [ -  + ]:          8 :         if (n_args == 1) {
      97                 :          8 :             pin = args[0];
      98         [ +  + ]:          8 :             if (n_kw == 0) {
      99   [ +  -  +  - ]:          2 :             } else if (n_kw == 1 && args[1] == MP_OBJ_NEW_QSTR(MP_QSTR_invert)) {
     100                 :          2 :                 invert = mp_obj_is_true(args[2]);
     101                 :            :             } else {
     102                 :          0 :                 goto error;
     103                 :            :             }
     104                 :            :         } else {
     105                 :          0 :         error:
     106                 :          0 :             mp_raise_TypeError(NULL);
     107                 :            :         }
     108                 :            :     }
     109                 :            : 
     110                 :          8 :     machine_signal_t *o = mp_obj_malloc(machine_signal_t, type);
     111                 :          8 :     o->pin = pin;
     112                 :          8 :     o->invert = invert;
     113                 :          8 :     return MP_OBJ_FROM_PTR(o);
     114                 :            : }
     115                 :            : 
     116                 :         20 : STATIC mp_uint_t signal_ioctl(mp_obj_t self_in, mp_uint_t request, uintptr_t arg, int *errcode) {
     117                 :         20 :     (void)errcode;
     118                 :         20 :     machine_signal_t *self = MP_OBJ_TO_PTR(self_in);
     119                 :            : 
     120      [ +  +  - ]:         20 :     switch (request) {
     121                 :         12 :         case MP_PIN_READ: {
     122                 :         12 :             return mp_virtual_pin_read(self->pin) ^ self->invert;
     123                 :            :         }
     124                 :          8 :         case MP_PIN_WRITE: {
     125                 :          8 :             mp_virtual_pin_write(self->pin, arg ^ self->invert);
     126                 :          8 :             return 0;
     127                 :            :         }
     128                 :            :     }
     129                 :            :     return -1;
     130                 :            : }
     131                 :            : 
     132                 :            : // fast method for getting/setting signal value
     133                 :         16 : STATIC mp_obj_t signal_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
     134                 :         16 :     mp_arg_check_num(n_args, n_kw, 0, 1, false);
     135         [ +  + ]:         16 :     if (n_args == 0) {
     136                 :            :         // get pin
     137                 :         12 :         return MP_OBJ_NEW_SMALL_INT(mp_virtual_pin_read(self_in));
     138                 :            :     } else {
     139                 :            :         // set pin
     140                 :          4 :         mp_virtual_pin_write(self_in, mp_obj_is_true(args[0]));
     141                 :          4 :         return mp_const_none;
     142                 :            :     }
     143                 :            : }
     144                 :            : 
     145                 :         12 : STATIC mp_obj_t signal_value(size_t n_args, const mp_obj_t *args) {
     146                 :         12 :     return signal_call(args[0], n_args - 1, 0, args + 1);
     147                 :            : }
     148                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(signal_value_obj, 1, 2, signal_value);
     149                 :            : 
     150                 :          2 : STATIC mp_obj_t signal_on(mp_obj_t self_in) {
     151                 :          2 :     mp_virtual_pin_write(self_in, 1);
     152                 :          2 :     return mp_const_none;
     153                 :            : }
     154                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(signal_on_obj, signal_on);
     155                 :            : 
     156                 :          2 : STATIC mp_obj_t signal_off(mp_obj_t self_in) {
     157                 :          2 :     mp_virtual_pin_write(self_in, 0);
     158                 :          2 :     return mp_const_none;
     159                 :            : }
     160                 :            : STATIC MP_DEFINE_CONST_FUN_OBJ_1(signal_off_obj, signal_off);
     161                 :            : 
     162                 :            : STATIC const mp_rom_map_elem_t signal_locals_dict_table[] = {
     163                 :            :     { MP_ROM_QSTR(MP_QSTR_value), MP_ROM_PTR(&signal_value_obj) },
     164                 :            :     { MP_ROM_QSTR(MP_QSTR_on), MP_ROM_PTR(&signal_on_obj) },
     165                 :            :     { MP_ROM_QSTR(MP_QSTR_off), MP_ROM_PTR(&signal_off_obj) },
     166                 :            : };
     167                 :            : 
     168                 :            : STATIC MP_DEFINE_CONST_DICT(signal_locals_dict, signal_locals_dict_table);
     169                 :            : 
     170                 :            : STATIC const mp_pin_p_t signal_pin_p = {
     171                 :            :     .ioctl = signal_ioctl,
     172                 :            : };
     173                 :            : 
     174                 :            : MP_DEFINE_CONST_OBJ_TYPE(
     175                 :            :     machine_signal_type,
     176                 :            :     MP_QSTR_Signal,
     177                 :            :     MP_TYPE_FLAG_NONE,
     178                 :            :     make_new, signal_make_new,
     179                 :            :     call, signal_call,
     180                 :            :     protocol, &signal_pin_p,
     181                 :            :     locals_dict, &signal_locals_dict
     182                 :            :     );
     183                 :            : 
     184                 :            : #endif // MICROPY_PY_MACHINE

Generated by: LCOV version 1.15-5-g462f71d