i2c.h

Go to the documentation of this file.

//   Copyright 2016-2023 Jean-Francois Poilpret
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
 
 
#ifndef I2C_HH
#define I2C_HH
 
#include <stdint.h>
#include "flash.h"
#include "ios.h"
 
//NOTE only Master operation is supported for the moment
namespace i2c
{
    enum class Status : uint8_t
    {
        OK = 0x00,
        START_TRANSMITTED = 0x08,
        REPEAT_START_TRANSMITTED = 0x10,
        SLA_W_TRANSMITTED_ACK = 0x18,
        SLA_W_TRANSMITTED_NACK = 0x20,
        DATA_TRANSMITTED_ACK = 0x28,
        DATA_TRANSMITTED_NACK = 0x30,
        ARBITRATION_LOST = 0x38,
        SLA_R_TRANSMITTED_ACK = 0x40,
        SLA_R_TRANSMITTED_NACK = 0x48,
        DATA_RECEIVED_ACK = 0x50,
        DATA_RECEIVED_NACK = 0x58,
    };
 
    template<typename OSTREAM> OSTREAM& operator<<(OSTREAM& out, Status s)
    {
        switch (s)
        {
            case Status::OK:
            out << F("OK");
            break;
            
            case Status::START_TRANSMITTED:
            out << F("START_TRANSMITTED");
            break;
            
            case Status::REPEAT_START_TRANSMITTED:
            out << F("REPEAT_START_TRANSMITTED");
            break;
            
            case Status::SLA_W_TRANSMITTED_ACK:
            out << F("SLA_W_TRANSMITTED_ACK");
            break;
            
            case Status::SLA_W_TRANSMITTED_NACK:
            out << F("SLA_W_TRANSMITTED_NACK");
            break;
            
            case Status::DATA_TRANSMITTED_ACK:
            out << F("DATA_TRANSMITTED_ACK");
            break;
            
            case Status::DATA_TRANSMITTED_NACK:
            out << F("DATA_TRANSMITTED_NACK");
            break;
            
            case Status::ARBITRATION_LOST:
            out << F("ARBITRATION_LOST");
            break;
            
            case Status::SLA_R_TRANSMITTED_ACK:
            out << F("SLA_R_TRANSMITTED_ACK");
            break;
            
            case Status::SLA_R_TRANSMITTED_NACK:
            out << F("SLA_R_TRANSMITTED_NACK");
            break;
            
            case Status::DATA_RECEIVED_ACK:
            out << F("DATA_RECEIVED_ACK");
            break;
            
            case Status::DATA_RECEIVED_NACK:
            out << F("DATA_RECEIVED_NACK");
            break;
            
            default:
            out << F("UNKNOWN[");
            out.setf(streams::ios::hex, streams::ios::basefield);
            out << uint8_t(s) << ']';
            break;
        }
        return out;
    }
 
    enum class I2CMode : uint8_t
    {
        STANDARD,
        FAST
    };
};
 
#endif /* I2C_HH */