NEORV32 - Software Framework Documentation
Loading...
Searching...
No Matches
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) 2023, 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/**********************************************************************/
51typedef volatile struct __attribute__((packed,aligned(4))) {
52 uint32_t CTRL;
53 uint32_t DATA;
55
57#define NEORV32_TWI ((neorv32_twi_t*) (NEORV32_TWI_BASE))
58
78
87/**********************************************************************/
91int neorv32_twi_available(void);
92void neorv32_twi_setup(int prsc, int cdiv, int csen);
93void neorv32_twi_disable(void);
94void neorv32_twi_enable(void);
97int neorv32_twi_busy(void);
98int neorv32_twi_start_trans(uint8_t a);
99int neorv32_twi_trans(uint8_t d);
100uint8_t neorv32_twi_get_data(void);
107#endif // neorv32_twi_h
NEORV32_TWI_DATA_enum
Definition neorv32_twi.h:80
@ TWI_DATA_MSB
Definition neorv32_twi.h:82
@ TWI_DATA_LSB
Definition neorv32_twi.h:81
void neorv32_twi_enable(void)
Definition neorv32_twi.c:95
uint8_t neorv32_twi_get_data(void)
Definition neorv32_twi.c:179
int neorv32_twi_busy(void)
Definition neorv32_twi.c:124
void neorv32_twi_setup(int prsc, int cdiv, int csen)
Definition neorv32_twi.c:70
void neorv32_twi_generate_start(void)
Definition neorv32_twi.c:202
void neorv32_twi_mack_disable(void)
Definition neorv32_twi.c:113
void neorv32_twi_mack_enable(void)
Definition neorv32_twi.c:104
NEORV32_TWI_CTRL_enum
Definition neorv32_twi.h:60
@ TWI_CTRL_STOP
Definition neorv32_twi.h:63
@ TWI_CTRL_CSEN
Definition neorv32_twi.h:65
@ TWI_CTRL_EN
Definition neorv32_twi.h:61
@ TWI_CTRL_BUSY
Definition neorv32_twi.h:76
@ TWI_CTRL_CDIV1
Definition neorv32_twi.h:70
@ TWI_CTRL_PRSC2
Definition neorv32_twi.h:68
@ TWI_CTRL_CLAIMED
Definition neorv32_twi.h:74
@ TWI_CTRL_CDIV0
Definition neorv32_twi.h:69
@ TWI_CTRL_PRSC1
Definition neorv32_twi.h:67
@ TWI_CTRL_PRSC0
Definition neorv32_twi.h:66
@ TWI_CTRL_CDIV3
Definition neorv32_twi.h:72
@ TWI_CTRL_CDIV2
Definition neorv32_twi.h:71
@ TWI_CTRL_ACK
Definition neorv32_twi.h:75
@ TWI_CTRL_MACK
Definition neorv32_twi.h:64
@ TWI_CTRL_START
Definition neorv32_twi.h:62
int neorv32_twi_available(void)
Definition neorv32_twi.c:52
int neorv32_twi_start_trans(uint8_t a)
Definition neorv32_twi.c:143
int neorv32_twi_bus_claimed(void)
Definition neorv32_twi.c:214
void neorv32_twi_generate_stop(void)
Definition neorv32_twi.c:190
int neorv32_twi_trans(uint8_t d)
Definition neorv32_twi.c:159
void neorv32_twi_disable(void)
Definition neorv32_twi.c:86
Definition neorv32_twi.h:51
uint32_t CTRL
Definition neorv32_twi.h:52
uint32_t DATA
Definition neorv32_twi.h:53