tcc.h

Go to the documentation of this file.

 
/*
 * MIT License
 *
 * Copyright (c) 2022 Joey Castillo
 *
 * 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.
 */
 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
#include "sam.h"
 
typedef enum {
    TCC_PRESCALER_DIV1 = 0,
    TCC_PRESCALER_DIV2 = 1,
    TCC_PRESCALER_DIV4 = 2,
    TCC_PRESCALER_DIV8 = 3,
    TCC_PRESCALER_DIV16 = 4,
    TCC_PRESCALER_DIV64 = 5,
    TCC_PRESCALER_DIV256 = 6,
    TCC_PRESCALER_DIV1024 = 7
} tcc_prescaler_value_t;
 
typedef enum {
    TCC_WAVEGEN_NORMAL_FREQUENCY = 0,
    TCC_WAVEGEN_MATCH_FREQUENCY = 1,
    TCC_WAVEGEN_NORMAL_PWM = 2,
// These modes may be supported in the future, but I don't have a use for them right now.
    // TCC_WAVEGEN_DUAL_SLOPE_TOP = 7,
    // TCC_WAVEGEN_DUAL_SLOPE_BOTTOM = 5,
    // TCC_WAVEGEN_DUAL_SLOPE_BOTH = 6,
    // TCC_WAVEGEN_DUAL_SLOPE_CRITICAL = 4,
} tcc_wavegen_t;
 
typedef enum {
    TCC_OUTPUT_MATRIX_MODULO_4 = 0,
    TCC_OUTPUT_MATRIX_MODULO_2 = 1,
    TCC_OUTPUT_MATRIX_ALL_CC0 = 2,
    TCC_OUTPUT_MATRIX_WO0_CC0_OTHERS_CC1 = 3,
} tcc_output_matrix_t;
 
typedef enum {
    TCC_CHANNEL_POLARITY_NORMAL = 0,
    TCC_CHANNEL_POLARITY_INVERTED = 1,
} tcc_channel_polarity_t;
 
bool tcc_init(uint8_t instance, generic_clock_generator_t clocksource, tcc_prescaler_value_t prescaler);
 
void tcc_set_run_in_standby(uint8_t instance, bool runStandby);
 
void tcc_set_wavegen(uint8_t instance, tcc_wavegen_t mode);
 
void tcc_set_output_matrix(uint8_t instance, tcc_output_matrix_t mode);
 
void tcc_set_channel_polarity(uint8_t instance, uint8_t channel, tcc_channel_polarity_t polarity);
 
void tcc_enable(uint8_t instance);
 
bool tcc_is_enabled(uint8_t instance);
 
void tcc_set_period(uint8_t instance, uint32_t period);
 
void tcc_set_cc(uint8_t instance, uint8_t channel, uint32_t value);
 
void tcc_set_count(uint8_t instance, uint32_t value);
 
uint32_t tcc_get_count(uint8_t instance);
 
void tcc_stop(uint8_t instance);
 
void tcc_retrigger(uint8_t instance);
 
void tcc_update(uint8_t instance);
 
void tcc_disable(uint8_t instance);