circuitpython/ports/raspberrypi/common-hal/pulseio/PulseIn.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

234 lines
8.3 KiB
C
Raw Normal View History

2021-03-09 00:23:51 -05:00
/*
2021-02-24 17:58:29 -05:00
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2021 Dave Putz for Adafruit Industries
2021-02-24 17:58:29 -05:00
*
* 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.
*/
#include "src/rp2_common/hardware_gpio/include/hardware/gpio.h"
#include <stdint.h>
#include "py/runtime.h"
#include "shared-bindings/microcontroller/__init__.h"
#include "shared-bindings/pulseio/PulseIn.h"
#include "shared-bindings/microcontroller/Pin.h"
#include "supervisor/shared/translate.h"
#include "bindings/rp2pio/StateMachine.h"
#include "common-hal/pulseio/PulseIn.h"
2021-03-15 09:57:36 -04:00
pulseio_pulsein_obj_t *save_self;
2021-02-24 17:58:29 -05:00
#define NO_PIN 0xff
2021-04-26 19:52:15 -04:00
#define MAX_PULSE 65535
#define MIN_PULSE 10
volatile bool last_level;
2021-04-26 19:52:15 -04:00
volatile uint32_t level_count = 0;
volatile uint32_t result = 0;
volatile uint16_t buf_index = 0;
uint16_t pulsein_program[] = {
0x4001, // 1: in pins, 1
2021-02-24 17:58:29 -05:00
};
2021-03-15 09:57:36 -04:00
void common_hal_pulseio_pulsein_construct(pulseio_pulsein_obj_t *self,
const mcu_pin_obj_t *pin, uint16_t maxlen, bool idle_state) {
2021-02-24 17:58:29 -05:00
2021-03-15 09:57:36 -04:00
self->buffer = (uint16_t *)m_malloc(maxlen * sizeof(uint16_t), false);
2021-02-24 17:58:29 -05:00
if (self->buffer == NULL) {
mp_raise_msg_varg(&mp_type_MemoryError, translate("Failed to allocate RX buffer of %d bytes"), maxlen * sizeof(uint16_t));
}
self->pin = pin->number;
self->maxlen = maxlen;
self->idle_state = idle_state;
self->start = 0;
self->len = 0;
save_self = self;
2021-04-25 12:58:22 -04:00
bool ok = rp2pio_statemachine_construct(&self->state_machine,
2021-02-24 17:58:29 -05:00
pulsein_program, sizeof(pulsein_program) / sizeof(pulsein_program[0]),
1000000,
2021-02-24 17:58:29 -05:00
NULL, 0,
NULL, 0,
pin, 1,
0,0,
2021-02-24 17:58:29 -05:00
NULL, 0,
NULL, 0,
1, 0,
2021-02-24 17:58:29 -05:00
1 << self->pin, false, true,
2021-03-15 09:57:36 -04:00
false, 8, false, // TX, unused
false,
true, 32, true, // RX auto-push every 32 bits
false); // claim pins
2021-04-25 12:58:22 -04:00
pio_sm_set_enabled(self->state_machine.pio,self->state_machine.state_machine, false);
pio_sm_clear_fifos(self->state_machine.pio,self->state_machine.state_machine);
last_level = self->idle_state;
level_count = 0;
result = 0;
buf_index = 0;
2021-02-24 17:58:29 -05:00
2021-04-25 12:58:22 -04:00
pio_sm_set_in_pins(self->state_machine.pio,self->state_machine.state_machine,pin->number);
common_hal_rp2pio_statemachine_set_interrupt_handler(&(self->state_machine),&common_hal_pulseio_pulsein_interrupt,NULL,PIO_IRQ0_INTE_SM0_RXNEMPTY_BITS);
2021-02-24 17:58:29 -05:00
// exec a set pindirs to 0 for input
2021-04-25 12:58:22 -04:00
pio_sm_exec(self->state_machine.pio,self->state_machine.state_machine,0xe080);
2021-03-15 09:57:36 -04:00
// exec the appropriate wait for pin
if (self->idle_state == true) {
pio_sm_exec(self->state_machine.pio,self->state_machine.state_machine,0x2020);
2021-03-09 17:37:29 -05:00
} else {
2021-03-15 09:57:36 -04:00
pio_sm_exec(self->state_machine.pio,self->state_machine.state_machine,0x20a0);
2021-03-09 17:37:29 -05:00
}
2021-04-25 12:58:22 -04:00
pio_sm_set_enabled(self->state_machine.pio, self->state_machine.state_machine, true);
2021-02-24 17:58:29 -05:00
}
2021-03-15 09:57:36 -04:00
bool common_hal_pulseio_pulsein_deinited(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
return self->pin == NO_PIN;
}
2021-03-15 09:57:36 -04:00
void common_hal_pulseio_pulsein_deinit(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
if (common_hal_pulseio_pulsein_deinited(self)) {
return;
}
2021-02-26 15:14:55 -05:00
pio_sm_set_enabled(self->state_machine.pio, self->state_machine.state_machine, false);
2021-04-25 12:58:22 -04:00
common_hal_rp2pio_statemachine_deinit(&self->state_machine);
2021-02-24 17:58:29 -05:00
m_free(self->buffer);
2021-04-25 12:58:22 -04:00
reset_pin_number(self->pin);
2021-02-24 17:58:29 -05:00
self->pin = NO_PIN;
}
2021-03-15 09:57:36 -04:00
void common_hal_pulseio_pulsein_pause(pulseio_pulsein_obj_t *self) {
2021-02-26 15:14:55 -05:00
pio_sm_set_enabled(self->state_machine.pio, self->state_machine.state_machine, false);
2021-02-24 17:58:29 -05:00
}
void common_hal_pulseio_pulsein_interrupt() {
2021-03-15 09:57:36 -04:00
pulseio_pulsein_obj_t *self = save_self;
uint32_t rxfifo = 0;
rxfifo = pio_sm_get_blocking(self->state_machine.pio, self->state_machine.state_machine);
// translate from fifo to buffer
for (uint i = 0; i < 32; i++) {
bool level = (rxfifo & (1 << i)) >> i;
2021-03-15 09:57:36 -04:00
if (level == last_level) {
level_count++;
} else {
2021-03-15 09:57:36 -04:00
result = level_count;
last_level = level;
level_count = 1;
codeformat: Fix filename matching In #4683, tannewt noticed that uncrustify was not running on some file in common-hal. I investigated and found that it was not being run on a bunch of paths. Rather than make incremental changes, I rewrote list_files to work bsaed on regular expressions; these regular expressions are created from the same git-style glob patterns. I spot-checked some specific filenames after this change, and all looks good: ``` $ python3 tools/codeformat.py -v --dry-run tests/basics/int_small.py ports/raspberrypi/common-hal/pulseio/PulseIn.c extmod/virtpin.c tests/thread/thread_exit1.py ports/raspberrypi/background.h extmod/re1.5/recursiveloop.c tools/codeformat.py -v --dry-run tests/basics/int_small.py ports/raspberrypi/common-hal/pulseio/PulseIn.c extmod/virtpin.c tests/thread/thread_exit1.py ports/raspberrypi/background.h extmod/re1.5/recursiveloop.c uncrustify -c /home/jepler/src/circuitpython/tools/uncrustify.cfg -lC --no-backup extmod/virtpin.c ports/raspberrypi/background.h ports/raspberrypi/common-hal/pulseio/PulseIn.c black --fast --line-length=99 -v tests/thread/thread_exit1.py ``` recursiveloop and int_small are excluded, while PulseIn, virtpin, and background are included. Testing running from a subdirectory (not _specifically_ supported though): ``` (cd ports && python3 ../tools/codeformat.py -v --dry-run raspberrypi/common-hal/pulseio/PulseIn.c ../extmod/virtpin.c) ../tools/codeformat.py -v --dry-run raspberrypi/common-hal/pulseio/PulseIn.c ../extmod/virtpin.c uncrustify -c /home/jepler/src/circuitpython/tools/uncrustify.cfg -lC --no-backup ../extmod/virtpin.c raspberrypi/common-hal/pulseio/PulseIn. ``` As a side-effect, a bunch more files are re-formatted now. :-P
2021-04-30 11:47:37 -04:00
// Pulses that are londger than MAX_PULSE will return MAX_PULSE
if (result > MAX_PULSE) {
result = MAX_PULSE;
}
2021-04-26 19:52:15 -04:00
// ignore pulses that are too short
if (result <= MAX_PULSE && result > MIN_PULSE) {
codeformat: Fix filename matching In #4683, tannewt noticed that uncrustify was not running on some file in common-hal. I investigated and found that it was not being run on a bunch of paths. Rather than make incremental changes, I rewrote list_files to work bsaed on regular expressions; these regular expressions are created from the same git-style glob patterns. I spot-checked some specific filenames after this change, and all looks good: ``` $ python3 tools/codeformat.py -v --dry-run tests/basics/int_small.py ports/raspberrypi/common-hal/pulseio/PulseIn.c extmod/virtpin.c tests/thread/thread_exit1.py ports/raspberrypi/background.h extmod/re1.5/recursiveloop.c tools/codeformat.py -v --dry-run tests/basics/int_small.py ports/raspberrypi/common-hal/pulseio/PulseIn.c extmod/virtpin.c tests/thread/thread_exit1.py ports/raspberrypi/background.h extmod/re1.5/recursiveloop.c uncrustify -c /home/jepler/src/circuitpython/tools/uncrustify.cfg -lC --no-backup extmod/virtpin.c ports/raspberrypi/background.h ports/raspberrypi/common-hal/pulseio/PulseIn.c black --fast --line-length=99 -v tests/thread/thread_exit1.py ``` recursiveloop and int_small are excluded, while PulseIn, virtpin, and background are included. Testing running from a subdirectory (not _specifically_ supported though): ``` (cd ports && python3 ../tools/codeformat.py -v --dry-run raspberrypi/common-hal/pulseio/PulseIn.c ../extmod/virtpin.c) ../tools/codeformat.py -v --dry-run raspberrypi/common-hal/pulseio/PulseIn.c ../extmod/virtpin.c uncrustify -c /home/jepler/src/circuitpython/tools/uncrustify.cfg -lC --no-backup ../extmod/virtpin.c raspberrypi/common-hal/pulseio/PulseIn. ``` As a side-effect, a bunch more files are re-formatted now. :-P
2021-04-30 11:47:37 -04:00
self->buffer[buf_index] = (uint16_t)result;
if (self->len < self->maxlen) {
self->len++;
}
if (buf_index < self->maxlen) {
buf_index++;
2021-04-29 13:38:13 -04:00
} else {
self->start = 0;
buf_index = 0;
2021-04-29 13:38:13 -04:00
}
2021-03-15 09:57:36 -04:00
}
}
}
2021-04-26 19:52:15 -04:00
// check for a pulse thats too long (MAX_PULSE us) or maxlen reached, and reset
if ((level_count > MAX_PULSE) || (buf_index >= self->maxlen)) {
2021-03-15 09:57:36 -04:00
pio_sm_set_enabled(self->state_machine.pio, self->state_machine.state_machine, false);
pio_sm_init(self->state_machine.pio, self->state_machine.state_machine, self->state_machine.offset, &self->state_machine.sm_config);
pio_sm_restart(self->state_machine.pio,self->state_machine.state_machine);
pio_sm_set_enabled(self->state_machine.pio, self->state_machine.state_machine, true);
2021-02-24 17:58:29 -05:00
}
}
2021-03-15 09:57:36 -04:00
void common_hal_pulseio_pulsein_resume(pulseio_pulsein_obj_t *self,
uint16_t trigger_duration) {
// exec a wait for the selected pin to change state
2021-03-15 09:57:36 -04:00
if (self->idle_state == true) {
pio_sm_exec(self->state_machine.pio,self->state_machine.state_machine,0x2020);
2021-03-09 17:37:29 -05:00
} else {
2021-03-15 09:57:36 -04:00
pio_sm_exec(self->state_machine.pio,self->state_machine.state_machine,0x20a0);
}
2021-02-24 17:58:29 -05:00
// Send the trigger pulse.
if (trigger_duration > 0) {
2021-03-15 09:57:36 -04:00
gpio_set_function(self->pin,GPIO_FUNC_SIO);
2021-02-24 17:58:29 -05:00
gpio_set_dir(self->pin,true);
2021-02-26 15:14:55 -05:00
gpio_put(self->pin, !self->idle_state);
2021-02-24 17:58:29 -05:00
common_hal_mcu_delay_us((uint32_t)trigger_duration);
2021-03-15 09:57:36 -04:00
gpio_set_function(self->pin,GPIO_FUNC_PIO0);
common_hal_mcu_delay_us(225);
}
// Reconfigure the pin for PIO
2021-02-24 17:58:29 -05:00
gpio_set_function(self->pin, GPIO_FUNC_PIO0);
2021-02-26 15:14:55 -05:00
pio_sm_set_enabled(self->state_machine.pio, self->state_machine.state_machine, true);
2021-02-24 17:58:29 -05:00
}
2021-03-15 09:57:36 -04:00
void common_hal_pulseio_pulsein_clear(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
self->start = 0;
self->len = 0;
2021-04-25 15:24:21 -04:00
buf_index = 0;
2021-02-24 17:58:29 -05:00
}
2021-03-15 09:57:36 -04:00
uint16_t common_hal_pulseio_pulsein_popleft(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
if (self->len == 0) {
mp_raise_IndexError_varg(translate("pop from empty %q"), MP_QSTR_PulseIn);
}
uint16_t value = self->buffer[self->start];
self->start = (self->start + 1) % self->maxlen;
self->len--;
// if we are empty reset buffer pointer and counters
2021-03-15 09:57:36 -04:00
if (self->len == 0) {
self->start = 0;
buf_index = 0;
level_count = 0;
2021-02-24 17:58:29 -05:00
}
return value;
}
2021-03-15 09:57:36 -04:00
uint16_t common_hal_pulseio_pulsein_get_maxlen(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
return self->maxlen;
}
2021-03-15 09:57:36 -04:00
uint16_t common_hal_pulseio_pulsein_get_len(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
return self->len;
}
2021-03-15 09:57:36 -04:00
bool common_hal_pulseio_pulsein_get_paused(pulseio_pulsein_obj_t *self) {
2021-02-24 17:58:29 -05:00
return true;
}
2021-03-15 09:57:36 -04:00
uint16_t common_hal_pulseio_pulsein_get_item(pulseio_pulsein_obj_t *self,
int16_t index) {
2021-02-24 17:58:29 -05:00
if (index < 0) {
index += self->len;
}
if (index < 0 || index >= self->len) {
mp_raise_IndexError_varg(translate("%q index out of range"), MP_QSTR_PulseIn);
}
uint16_t value = self->buffer[(self->start + index) % self->maxlen];
return value;
}