gossamer 0.0.1
a very lightweight app framework for SAMD and SAML chips
Loading...
Searching...
No Matches
tc.h
1
2/*
3 * MIT License
4 *
5 * Copyright (c) 2022 Joey Castillo
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26#pragma once
27
28#include <stdint.h>
29#include <stdbool.h>
30#include "sam.h"
31#include "system.h"
32
39typedef enum {
40 TC_PRESCALER_DIV1 = 0,
41 TC_PRESCALER_DIV2 = 1,
42 TC_PRESCALER_DIV4 = 2,
43 TC_PRESCALER_DIV8 = 3,
44 TC_PRESCALER_DIV16 = 4,
45 TC_PRESCALER_DIV64 = 5,
46 TC_PRESCALER_DIV256 = 6,
47 TC_PRESCALER_DIV1024 = 7
48} tc_prescaler_value_t;
49
50typedef enum {
51 TC_COUNTER_MODE_16BIT = 0,
52 TC_COUNTER_MODE_8BIT = 1,
53 TC_COUNTER_MODE_32BIT = 2,
54} tc_counter_mode_t;
55
56typedef enum {
57 TC_WAVEGEN_NORMAL_FREQUENCY = 0,
58 TC_WAVEGEN_MATCH_FREQUENCY = 1,
59 TC_WAVEGEN_NORMAL_PWM = 2,
60 TC_WAVEGEN_MATCH_PWM = 3,
61} tc_wavegen_t;
62
63typedef enum {
64 TC_CHANNEL_POLARITY_NORMAL = 0,
65 TC_CHANNEL_POLARITY_INVERTED = 1,
66} tc_channel_polarity_t;
67
68typedef enum {
69 TC_EVENT_ACTION_DISABLED = 0x0ul,
70 TC_EVENT_ACTION_RETRIGGER = 0x1ul,
71 TC_EVENT_ACTION_COUNT = 0x2ul,
72 TC_EVENT_ACTION_START = 0x3ul,
73 TC_EVENT_ACTION_STAMP = 0x4ul,
75 TC_EVENT_ACTION_PWP = 0x6ul,
76 TC_EVENT_ACTION_PW = 0x7ul,
78
100bool tc_init(uint8_t instance, generic_clock_generator_t clocksource, tc_prescaler_value_t prescaler);
101
121void tc_set_counter_mode(uint8_t instance, tc_counter_mode_t mode);
122
128void tc_set_run_in_standby(uint8_t instance, bool runStandby);
129
154void tc_set_wavegen(uint8_t instance, tc_wavegen_t mode);
155
168void tc_set_channel_polarity(uint8_t instance, uint8_t channel, tc_channel_polarity_t polarity);
169
173void tc_enable(uint8_t instance);
174
179bool tc_is_enabled(uint8_t instance);
180
187void tc_count8_set_period(uint8_t instance, uint8_t period);
188
194uint8_t tc_count8_get_period(uint8_t instance);
195
203void tc_count8_set_cc(uint8_t instance, uint8_t channel, uint8_t value);
204
212void tc_count16_set_cc(uint8_t instance, uint8_t channel, uint16_t value);
213
220void tc_count32_set_cc(uint8_t instance, uint8_t channel, uint32_t value);
221
227void tc_count8_set_count(uint8_t instance, uint8_t value);
228
236void tc_count16_set_count(uint8_t instance, uint16_t value);
237
243void tc_count32_set_count(uint8_t instance, uint32_t value);
244
250uint8_t tc_count8_get_count(uint8_t instance);
251
259uint16_t tc_count16_get_count(uint8_t instance);
260
266uint32_t tc_count32_get_count(uint8_t instance);
267
273void tc_set_event_action(uint8_t instance, tc_event_action_t action);
274
282void tc_stop(uint8_t instance);
283
291void tc_retrigger(uint8_t instance);
292
296void tc_disable(uint8_t instance);
297
uint8_t tc_count8_get_count(uint8_t instance)
Gets the TC's current counter value in 8-bit mode.
Definition tc.c:156
void tc_set_run_in_standby(uint8_t instance, bool runStandby)
Sets the TC's run-in-standby mode.
Definition tc.c:74
void tc_stop(uint8_t instance)
Issues a STOP command to the TC.
Definition tc.c:176
bool tc_is_enabled(uint8_t instance)
Checks whether the TC is enabled.
Definition tc.c:110
bool tc_init(uint8_t instance, generic_clock_generator_t clocksource, tc_prescaler_value_t prescaler)
Enables the peripheral clock for the TC and clocks it with the selected clock source....
Definition tc.c:36
void tc_enable(uint8_t instance)
Enables the TC. Make sure to call tc_init first to set it up.
Definition tc.c:105
void tc_count16_set_count(uint8_t instance, uint16_t value)
Sets the TC's counter value in 16-bit mode.
Definition tc.c:138
uint16_t tc_count16_get_count(uint8_t instance)
Gets the TC's current counter value in 16-bit mode.
Definition tc.c:161
void tc_count16_set_cc(uint8_t instance, uint8_t channel, uint16_t value)
Sets the TC's compare channel CC0 or CC1 register in 16-bit mode.
Definition tc.c:126
void tc_count8_set_count(uint8_t instance, uint8_t value)
Sets the TC's counter value in 8-bit mode.
Definition tc.c:134
void tc_count32_set_count(uint8_t instance, uint32_t value)
Sets the TC's counter value in 32-bit mode.
Definition tc.c:142
void tc_count32_set_cc(uint8_t instance, uint8_t channel, uint32_t value)
Sets the TC's compare channel CC0 or CC1 register in 32-bit mode.
Definition tc.c:130
void tc_set_event_action(uint8_t instance, tc_event_action_t action)
Sets the action to take when the TC receives an event.
Definition tc.c:171
void tc_count8_set_cc(uint8_t instance, uint8_t channel, uint8_t value)
Sets the TC's compare channel CC0 or CC1 register in 8-bit mode.
Definition tc.c:122
uint8_t tc_count8_get_period(uint8_t instance)
Gets the TC's period or PER register in 8-bit mode.
Definition tc.c:118
uint32_t tc_count32_get_count(uint8_t instance)
Gets the TC's current counter value in 32-bit mode.
Definition tc.c:166
void tc_retrigger(uint8_t instance)
Issues a RETRIGGER command to the TC.
Definition tc.c:180
void tc_count8_set_period(uint8_t instance, uint8_t period)
Sets the TC's period or PER register in 8-bit mode.
Definition tc.c:114
void tc_set_counter_mode(uint8_t instance, tc_counter_mode_t mode)
Sets the TC's counting mode (an 8, 16 or 32-bit counter),.
Definition tc.c:70
tc_event_action_t
Definition tc.h:68
void tc_disable(uint8_t instance)
Disables the TC, but retains all its settings.
Definition tc.c:184
void tc_set_channel_polarity(uint8_t instance, uint8_t channel, tc_channel_polarity_t polarity)
Sets the polarity of one of the waveform output channels.
Definition tc.c:86
void tc_set_wavegen(uint8_t instance, tc_wavegen_t mode)
Sets the TC's waveform generation mode.
Definition tc.c:78
@ TC_EVENT_ACTION_PPW
NOTE: Not available on SAM D11 or D21.
Definition tc.h:74