text: //-----------------------------------------------------------------------------------------------------------------------------
  // Copyright (c) 2018 Juho Lepistö
  // 
  // Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
  // documentation files (the "Software"), to deal in the Software without restriction, including without 
  // limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
  // the Software, and to permit persons to whom the Software is furnished to do so, subject to the following
  // conditions:
  //
  // The above copyright notice and this permission notice shall be included in all copies or substantial
  // portions of the Software.
  // 
  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
  // TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  // CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  // IN THE SOFTWARE.
  //-----------------------------------------------------------------------------------------------------------------------------
  
  //! @file    Hal_Clocks_Mock.hpp
  //! @author  Juho Lepistö <juho.lepisto(a)gmail.com>
  //! @date    20 May 2019
  //!
  //! @brief   Mocks for clocks HAL.
  //! 
  //! These are initialisation functions for mocks. The mocks are utilising FakeIt framework.
  
  #ifndef HAL_GPIO_MOCK_HPP_
  #define HAL_GPIO_MOCK_HPP_
  
  //-----------------------------------------------------------------------------------------------------------------------------
  // 1. Framework Dependencies
  //-----------------------------------------------------------------------------------------------------------------------------
  
  #include <catch.hpp>
  #include <fakeit.hpp>
  using namespace fakeit;
  
  #include <Hal_Clocks.hpp>
  
  //-----------------------------------------------------------------------------------------------------------------------------
  // 2. Mock Init Prototypes
  //-----------------------------------------------------------------------------------------------------------------------------
  
  namespace HalMock
  {
  
  //! @class Clocks
  //! @brief This is a mock class for clocks HAL
  class Clocks
  {
  public:
      /// @brief Simple constructor.
      explicit Clocks(void) {};
  
      virtual Hal::Error Enable(Hal::OscillatorType type);
      virtual Hal::Error Disable(Hal::OscillatorType type);
      virtual Hal::Error ConfigurePll(OscillatorType source, uint32_t frequency);
      virtual Hal::Error ConfigurePllManually(OscillatorType source, pllRegisters_t const& registers);
      virtual OscillatorType GetPllSource(void);
      virtual bool IsRunning(Hal::OscillatorType type);
      virtual uint32_t GetSysClockFrequency(void);
      virtual Error SetSysClockSource(Hal::OscillatorType type);
      virtual Hal::OscillatorType GetSysClockSource(void);
  
  private:
      
  };
  
  extern Mock<Clocks> mockHalClocks;
  
  /// @brief This function initialises the HAL Gpio mock.
  void InitClocks(void);
  
  } // namespace HalMock
  
  #endif // HAL_GPIO_MOCK_HPP_
  