NEORV32 - Software Framework Documentation
neorv32_twi.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_twi.h - Two-Wire Interface Controller (TWI) HW Driver >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2022, 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_twi_h
44#define neorv32_twi_h
45
46// prototypes
47int neorv32_twi_available(void);
48void neorv32_twi_setup(uint8_t prsc);
49void neorv32_twi_disable(void);
50void neorv32_twi_enable(void);
53int neorv32_twi_busy(void);
54int neorv32_twi_start_trans(uint8_t a);
55int neorv32_twi_trans(uint8_t d);
56uint8_t neorv32_twi_get_data(void);
60
61#endif // neorv32_twi_h
void neorv32_twi_enable(void)
Definition: neorv32_twi.c:94
uint8_t neorv32_twi_get_data(void)
Definition: neorv32_twi.c:178
int neorv32_twi_busy(void)
Definition: neorv32_twi.c:123
void neorv32_twi_generate_start(void)
Definition: neorv32_twi.c:201
void neorv32_twi_mack_disable(void)
Definition: neorv32_twi.c:112
void neorv32_twi_mack_enable(void)
Definition: neorv32_twi.c:103
void neorv32_twi_setup(uint8_t prsc)
Definition: neorv32_twi.c:68
int neorv32_twi_available(void)
Definition: neorv32_twi.c:52
int neorv32_twi_start_trans(uint8_t a)
Definition: neorv32_twi.c:142
int neorv32_twi_bus_claimed(void)
Definition: neorv32_twi.c:213
void neorv32_twi_generate_stop(void)
Definition: neorv32_twi.c:189
int neorv32_twi_trans(uint8_t d)
Definition: neorv32_twi.c:158
void neorv32_twi_disable(void)
Definition: neorv32_twi.c:85