gossamer 0.0.1
a very lightweight app framework for SAMD and SAML chips
Loading...
Searching...
No Matches
adc.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
31
54void adc_init(void);
55
59void adc_enable(void);
60
65bool adc_is_enabled(void);
66
76void adc_set_sampling_length(uint8_t length);
77
84uint16_t adc_get_analog_value(uint8_t pin);
85
91uint16_t adc_get_analog_value_for_channel(uint8_t channel);
92
96void adc_disable(void);
97
103void adc_enable_start_event(bool enabled);
104
113void adc_enable_result_ready_event_output(bool enabled);
114
void adc_set_sampling_length(uint8_t length)
Sets the sampling length for the ADC.
Definition adc.c:80
uint16_t adc_get_analog_value_for_channel(uint8_t channel)
Gets the analog value on the given ADC channel.
Definition adc.c:86
void adc_init(void)
Initializes the ADC peripheral, but does not enable it.
Definition adc.c:107
void adc_enable(void)
Enables the ADC peripheral.
Definition adc.c:188
void adc_disable(void)
Disables the ADC peripheral.
Definition adc.c:207
void adc_enable_result_ready_event_output(bool enabled)
Enables or disables the result ready event output.
Definition adc.c:203
void adc_enable_start_event(bool enabled)
Enables or disables event-triggered ADC conversion start.
Definition adc.c:199
uint16_t adc_get_analog_value(uint8_t pin)
Gets the analog value on the given ADC pin.
Definition adc.c:98
bool adc_is_enabled(void)
Checks if the ADC is currently enabled.
Definition adc.c:195