neorv32_twi.h

Go to the documentation of this file.

// #################################################################################################
// # << NEORV32: neorv32_twi.h - Two-Wire Interface Controller (TWI) HW Driver >>                  #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2023, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # Redistribution and use in source and binary forms, with or without modification, are          #
// # permitted provided that the following conditions are met:                                     #
// #                                                                                               #
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
// #    conditions and the following disclaimer.                                                   #
// #                                                                                               #
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #
// #    conditions and the following disclaimer in the documentation and/or other materials        #
// #    provided with the distribution.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
// #    endorse or promote products derived from this software without specific prior written      #
// #    permission.                                                                                #
// #                                                                                               #
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************/
#ifndef neorv32_twi_h
#define neorv32_twi_h
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL;  
  uint32_t DATA;  
} neorv32_twi_t;
 
#define NEORV32_TWI ((neorv32_twi_t*) (NEORV32_TWI_BASE))
 
enum NEORV32_TWI_CTRL_enum {
  TWI_CTRL_EN      =  0, 
  TWI_CTRL_START   =  1, 
  TWI_CTRL_STOP    =  2, 
  TWI_CTRL_MACK    =  3, 
  TWI_CTRL_CSEN    =  4, 
  TWI_CTRL_PRSC0   =  5, 
  TWI_CTRL_PRSC1   =  6, 
  TWI_CTRL_PRSC2   =  7, 
  TWI_CTRL_CDIV0   =  8, 
  TWI_CTRL_CDIV1   =  9, 
  TWI_CTRL_CDIV2   = 10, 
  TWI_CTRL_CDIV3   = 11, 
  TWI_CTRL_CLAIMED = 29, 
  TWI_CTRL_ACK     = 30, 
  TWI_CTRL_BUSY    = 31  
};
 
enum NEORV32_TWI_DATA_enum {
  TWI_DATA_LSB = 0, 
  TWI_DATA_MSB = 7  
};
/**********************************************************************/
int     neorv32_twi_available(void);
void    neorv32_twi_setup(int prsc, int cdiv, int csen);
void    neorv32_twi_disable(void);
void    neorv32_twi_enable(void);
void    neorv32_twi_mack_enable(void);
void    neorv32_twi_mack_disable(void);
int     neorv32_twi_busy(void);
int     neorv32_twi_start_trans(uint8_t a);
int     neorv32_twi_trans(uint8_t d);
uint8_t neorv32_twi_get_data(void);
void    neorv32_twi_generate_stop(void);
void    neorv32_twi_generate_start(void);
int     neorv32_twi_bus_claimed(void);
#endif // neorv32_twi_h