Serial Wombat Arduino Library
SerialWombatHSClock.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 Copyright 2023 Broadwell Consulting Inc.
4 
5 "Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
6 the United States. See SerialWombat.com for usage guidance.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the "Software"),
10  * to deal in the Software without restriction, including without limitation
11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12  * and/or sell copies of the Software, and to permit persons to whom the
13  * Software is furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24  * OTHER DEALINGS IN THE SOFTWARE.
25 */
26 
27 
28 #include <stdint.h>
29 #include "SerialWombat.h"
30 
31 
61 class
63 {
64  public:
68 
73  int32_t begin(uint8_t pin, uint32_t frequency_Hz);
74 
76  int16_t disable ();
77 };
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:272
SerialWombat.h
SerialWombatHSClock::disable
int16_t disable()
Disables the high speed clock output.
Definition: SerialWombatHSClock.cpp:32
SerialWombatHSClock::begin
int32_t begin(uint8_t pin, uint32_t frequency_Hz)
Begin outputing a clock at a frequency on a specified pin.
Definition: SerialWombatHSClock.cpp:8
SerialWombatPin
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombat.h:799
SerialWombatHSClock
A Class which outputs a high speed clock signal suitable for clocking other devices.
Definition: SerialWombatHSClock.h:61
SerialWombatPin::pin
uint8_t pin()
Returns the current SW pin number. Used primarily for virtual calls by derived classes.
Definition: SerialWombat.h:861
SerialWombatHSClock::SerialWombatHSClock
SerialWombatHSClock(SerialWombatChip &sw)
Class constructor for SerialWombatHSClock pin mode.
Definition: SerialWombatHSClock.cpp:4