comparison: components/esp32-owb/include/owb_rmt.h
components/esp32-owb/include/owb_rmt.h
- changeset 0
- 88d965579617
- child 72
- acc1904cd70d
equal
deleted
inserted
replaced
| -1:000000000000 | 0:88d965579617 |
|---|---|
| 1 /* | |
| 2 * MIT License | |
| 3 * | |
| 4 * Copyright (c) 2017 David Antliff | |
| 5 * Copyright (c) 2017 Chris Morgan <chmorgan@gmail.com> | |
| 6 * | |
| 7 * Permission is hereby granted, free of charge, to any person obtaining a copy | |
| 8 * of this software and associated documentation files (the "Software"), to deal | |
| 9 * in the Software without restriction, including without limitation the rights | |
| 10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 11 * copies of the Software, and to permit persons to whom the Software is | |
| 12 * furnished to do so, subject to the following conditions: | |
| 13 * | |
| 14 * The above copyright notice and this permission notice shall be included in all | |
| 15 * copies or substantial portions of the Software. | |
| 16 * | |
| 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
| 18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
| 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
| 20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
| 21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
| 22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
| 23 * SOFTWARE. | |
| 24 */ | |
| 25 | |
| 26 #pragma once | |
| 27 #ifndef OWB_RMT_H | |
| 28 #define OWB_RMT_H | |
| 29 | |
| 30 #include "freertos/FreeRTOS.h" | |
| 31 #include "freertos/queue.h" | |
| 32 #include "freertos/ringbuf.h" | |
| 33 #include "driver/rmt.h" | |
| 34 | |
| 35 #ifdef __cplusplus | |
| 36 extern "C" { | |
| 37 #endif | |
| 38 | |
| 39 typedef struct | |
| 40 { | |
| 41 int tx_channel; ///< RMT channel to use for TX | |
| 42 int rx_channel; ///< RMT channel to use for RX | |
| 43 RingbufHandle_t rb; ///< Ring buffer handle | |
| 44 int gpio; ///< OneWireBus GPIO | |
| 45 OneWireBus bus; ///< OneWireBus instance | |
| 46 } owb_rmt_driver_info; | |
| 47 | |
| 48 /** | |
| 49 * @brief Initialise the RMT driver. | |
| 50 * @return OneWireBus*, pass this into the other OneWireBus public API functions | |
| 51 */ | |
| 52 OneWireBus* owb_rmt_initialize(owb_rmt_driver_info *info, uint8_t gpio_num, | |
| 53 rmt_channel_t tx_channel, rmt_channel_t rx_channel); | |
| 54 | |
| 55 #ifdef __cplusplus | |
| 56 } | |
| 57 #endif | |
| 58 | |
| 59 #endif // OWB_RMT_H |
