NEORV32 - Software Framework Documentation
Loading...
Searching...
No Matches
neorv32_onewire.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_onewire.h - 1-Wire Interface Controller HW Driver (Header) >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2024, Stephan Nolting. All rights reserved. #
7// # #
8// # Redistribution and use in source and binary forms, with or without modification, are #
9// # permitted provided that the following conditions are met: #
10// # #
11// # 1. Redistributions of source code must retain the above copyright notice, this list of #
12// # conditions and the following disclaimer. #
13// # #
14// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
15// # conditions and the following disclaimer in the documentation and/or other materials #
16// # provided with the distribution. #
17// # #
18// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
19// # endorse or promote products derived from this software without specific prior written #
20// # permission. #
21// # #
22// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
23// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
24// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
25// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
26// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
28// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
29// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
30// # OF THE POSSIBILITY OF SUCH DAMAGE. #
31// # ********************************************************************************************* #
32// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
33// #################################################################################################
34
35
36/**********************************************************************/
43#ifndef neorv32_onewire_h
44#define neorv32_onewire_h
45
46/**********************************************************************/
51typedef volatile struct __attribute__((packed,aligned(4))) {
52 uint32_t CTRL;
53 uint32_t DATA;
55
57#define NEORV32_ONEWIRE ((neorv32_onewire_t*) (NEORV32_ONEWIRE_BASE))
58
80
89/**********************************************************************/
94int neorv32_onewire_setup(uint32_t t_base);
95void neorv32_onewire_enable(void);
97int neorv32_onewire_sense(void);
98
99int neorv32_onewire_busy(void);
100void neorv32_onewire_reset(void);
102void neorv32_onewire_read_bit(void);
103uint8_t neorv32_onewire_read_bit_get(void);
104void neorv32_onewire_write_bit(uint8_t bit);
107void neorv32_onewire_write_byte(uint8_t byte);
108
111void neorv32_onewire_write_bit_blocking(uint8_t bit);
113void neorv32_onewire_write_byte_blocking(uint8_t byte);
117#endif // neorv32_onewire_h
int neorv32_onewire_busy(void)
Definition neorv32_onewire.c:156
void neorv32_onewire_read_byte(void)
Definition neorv32_onewire.c:260
int neorv32_onewire_sense(void)
Definition neorv32_onewire.c:133
int neorv32_onewire_setup(uint32_t t_base)
Definition neorv32_onewire.c:69
void neorv32_onewire_write_byte(uint8_t byte)
Definition neorv32_onewire.c:291
void neorv32_onewire_reset(void)
Definition neorv32_onewire.c:173
int neorv32_onewire_reset_get_presence(void)
Definition neorv32_onewire.c:187
void neorv32_onewire_write_bit(uint8_t bit)
Definition neorv32_onewire.c:240
uint8_t neorv32_onewire_read_byte_get(void)
Definition neorv32_onewire.c:277
void neorv32_onewire_write_bit_blocking(uint8_t bit)
Definition neorv32_onewire.c:353
uint8_t neorv32_onewire_read_byte_blocking(void)
Definition neorv32_onewire.c:370
void neorv32_onewire_disable(void)
Definition neorv32_onewire.c:122
int neorv32_onewire_available(void)
Definition neorv32_onewire.c:52
uint8_t neorv32_onewire_read_bit_get(void)
Definition neorv32_onewire.c:221
void neorv32_onewire_read_bit(void)
Definition neorv32_onewire.c:204
void neorv32_onewire_write_byte_blocking(uint8_t byte)
Definition neorv32_onewire.c:390
uint8_t neorv32_onewire_read_bit_blocking(void)
Definition neorv32_onewire.c:333
NEORV32_ONEWIRE_CTRL_enum
Definition neorv32_onewire.h:60
@ ONEWIRE_CTRL_CLKDIV6
Definition neorv32_onewire.h:70
@ ONEWIRE_CTRL_CLKDIV4
Definition neorv32_onewire.h:68
@ ONEWIRE_CTRL_CLKDIV5
Definition neorv32_onewire.h:69
@ ONEWIRE_CTRL_TRIG_BIT
Definition neorv32_onewire.h:73
@ ONEWIRE_CTRL_CLKDIV7
Definition neorv32_onewire.h:71
@ ONEWIRE_CTRL_PRESENCE
Definition neorv32_onewire.h:77
@ ONEWIRE_CTRL_TRIG_RST
Definition neorv32_onewire.h:72
@ ONEWIRE_CTRL_BUSY
Definition neorv32_onewire.h:78
@ ONEWIRE_CTRL_CLKDIV3
Definition neorv32_onewire.h:67
@ ONEWIRE_CTRL_EN
Definition neorv32_onewire.h:61
@ ONEWIRE_CTRL_PRSC0
Definition neorv32_onewire.h:62
@ ONEWIRE_CTRL_CLKDIV0
Definition neorv32_onewire.h:64
@ ONEWIRE_CTRL_TRIG_BYTE
Definition neorv32_onewire.h:74
@ ONEWIRE_CTRL_CLKDIV2
Definition neorv32_onewire.h:66
@ ONEWIRE_CTRL_PRSC1
Definition neorv32_onewire.h:63
@ ONEWIRE_CTRL_SENSE
Definition neorv32_onewire.h:76
@ ONEWIRE_CTRL_CLKDIV1
Definition neorv32_onewire.h:65
void neorv32_onewire_enable(void)
Definition neorv32_onewire.c:113
NEORV32_ONEWIRE_DATA_enum
Definition neorv32_onewire.h:82
@ ONEWIRE_DATA_LSB
Definition neorv32_onewire.h:83
@ ONEWIRE_DATA_MSB
Definition neorv32_onewire.h:84
int neorv32_onewire_reset_blocking(void)
Definition neorv32_onewire.c:313
Definition neorv32_onewire.h:51
uint32_t DATA
Definition neorv32_onewire.h:53
uint32_t CTRL
Definition neorv32_onewire.h:52