twi.h

Go to the documentation of this file.

/*
 *  This file is part of the Home2L project.
 *
 *  (C) 2015-2021 Gundolf Kiefer
 *
 *  Home2L is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Home2L is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Home2L. If not, see <https://www.gnu.org/licenses/>.
 *
 */
 
 
#ifndef _TWI_
#define _TWI_
 
 
#include "core.h"
 
 
 
 
// *************************** TWI Slave ***************************************
 
 
 
 
 
// ***** General *****
 
void TwiSlInit ();
void TwiSlDone ();
 
EBrStatus TwiSlIterate ();
 
 
 
// ***** BrRequests and replies *****
 
extern /* const */ TBrRequest twiSlRequest;
extern TBrReply twiSlReply;
 
void TwiSlReplyCommit (uint8_t bytes);
void TwiSlReplyCommitPartial (uint8_t bytes, bool complete);
void TwiSlReplyFlush ();
 
 
 
// ***** Host notification *****
 
 
#if TWI_SL_NOTIFY || DOXYGEN
 
extern bool twiSlNotifyPending;   
 
static inline void TwiSlNotify () { twiSlNotifyPending = true; }
 
#else
 
static inline void TwiSlNotify () {}
 
#endif
 
 
 
 
 
// *************************** TWI Master **************************************
 
 
 
 
#if WITH_TWI_MASTER || DOXYGEN
 
 
void TwiMaInit ();                    
 
#if TWI_MA_PORTS > 1 || DOXYGEN
extern int8_t twiMaPort;              
static inline void TwiMaSelectPort (int8_t port) { twiMaPort = port; }
#else
static inline void TwiMaSelectPort (int8_t port) {}
#endif
 
void TwiMaSendStart ();               
void TwiMaSendStop ();                
bool TwiMaSendByte (uint8_t data);    
uint8_t TwiMaReceiveByte (bool ack);  
 
 
#endif // WITH_TWI_MASTER
 
 
 
 
 
// ************************** TWI Hub (Uses Master) ****************************
 
 
 
 
#if WITH_TWIHUB || DOXYGEN
 
 
static inline void TwiHubInit () { TwiMaInit (); }
 
void TwiHubIterate ();
 
static inline void TwiHubOnRegRead (uint8_t reg) {}
static inline void TwiHubOnRegWrite (uint8_t reg, uint8_t val) {}
 
 
#else   // WITH_TWIHUB
 
 
static inline void TwiHubInit () {}
static inline void TwiHubIterate () {}
static inline void TwiHubOnRegRead (uint8_t reg) {}
static inline void TwiHubOnRegWrite (uint8_t reg, uint8_t val) {}
 
 
#endif  // WITH_TWIHUB
 
 
 
 
 
#endif // _TWI_