uart_base.h

// Copyright 2024 The Pigweed Authors
//
// 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
//
//     https://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.
 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
#include "pw_status/status.h"
 
namespace pw::uart {
 
 
class UartBase {
 public:
  virtual ~UartBase() = default;
 
  Status Enable() { return DoEnable(true); }
 
  Status Disable() { return DoEnable(false); }
 
  Status SetBaudRate(uint32_t baud_rate) { return DoSetBaudRate(baud_rate); }
 
  Status SetFlowControl(bool enable) { return DoSetFlowControl(enable); }
 
  size_t ConservativeReadAvailable() { return DoConservativeReadAvailable(); }
 
  Status ClearPendingReceiveBytes() { return DoClearPendingReceiveBytes(); }
 
 private:
  virtual Status DoEnable(bool enable) = 0;
  virtual Status DoSetBaudRate(uint32_t baud_rate) = 0;
  virtual Status DoSetFlowControl(bool /*enable*/) {
    return pw::Status::Unimplemented();
  }
  virtual size_t DoConservativeReadAvailable() = 0;
  virtual Status DoClearPendingReceiveBytes() = 0;
};
 
}  // namespace pw::uart