BitBangI2C.hxx File Reference

#include "I2C.hxx"
#include "os/Gpio.hxx"
#include "os/OS.hxx"

Go to the source code of this file.

Classes
class	BitBangI2CStates
	Consolidate all the state machine enumerations for easy operator overloading. More...
class	BitBangI2C< HW >
	Implement a bit-banged I2C master. More...

Functions
BitBangI2CStates::StateStart &	operator++ (BitBangI2CStates::StateStart &x)
	Pre-increment operator overload.
BitBangI2CStates::StateStop &	operator++ (BitBangI2CStates::StateStop &x)
	Pre-increment operator overload.
BitBangI2CStates::StateTx &	operator++ (BitBangI2CStates::StateTx &x)
	Pre-increment operator overload.
BitBangI2CStates::StateRx &	operator++ (BitBangI2CStates::StateRx &x)
	Pre-increment operator overload.
BitBangI2CStates::StateRecovery &	operator++ (BitBangI2CStates::StateRecovery &x)
	Pre-increment operator overload.

Detailed Description

Copyright

Copyright (c) 2023, Stuart W Baker All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• 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.

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.

This file implements a bit bang implementation of I2C.

Author

Stuart W. Baker

Date

28 March 2023

Definition in file BitBangI2C.hxx.

Function Documentation

operator++() [1/5]

BitBangI2CStates::StateRecovery & operator++ ( BitBangI2CStates::StateRecovery &  x )

inline

Pre-increment operator overload.

Allow pre-increment definition.

Parameters

x	starting value

Returns

incremented value

Definition at line 374 of file BitBangI2C.hxx.

operator++() [2/5]

BitBangI2CStates::StateRx & operator++ ( BitBangI2CStates::StateRx &  x )

inline

Pre-increment operator overload.

Allow pre-increment definition.

Parameters

x	starting value

Returns

incremented value

Definition at line 361 of file BitBangI2C.hxx.

operator++() [3/5]

BitBangI2CStates::StateStart & operator++ ( BitBangI2CStates::StateStart &  x )

inline

Pre-increment operator overload.

Allow pre-increment definition.

Parameters

x	starting value

Returns

incremented value

Definition at line 322 of file BitBangI2C.hxx.

operator++() [4/5]

BitBangI2CStates::StateStop & operator++ ( BitBangI2CStates::StateStop &  x )

inline

Pre-increment operator overload.

Allow pre-increment definition.

Parameters

x	starting value

Returns

incremented value

Definition at line 335 of file BitBangI2C.hxx.

operator++() [5/5]

BitBangI2CStates::StateTx & operator++ ( BitBangI2CStates::StateTx &  x )

inline

Pre-increment operator overload.

Allow pre-increment definition.

Parameters

x	starting value

Returns

incremented value

Definition at line 348 of file BitBangI2C.hxx.