Zephyr API Documentation  3.7.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
current_sense_amplifier.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 The ChromiumOS Authors
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_DRIVERS_ADC_CURRENT_SENSE_AMPLIFIER_H_
8#define ZEPHYR_INCLUDE_DRIVERS_ADC_CURRENT_SENSE_AMPLIFIER_H_
9
10#include <zephyr/drivers/adc.h>
11#include <zephyr/drivers/gpio.h>
12
14 const struct adc_dt_spec port;
19};
20
31#define CURRENT_SENSE_AMPLIFIER_DT_SPEC_GET(node_id) \
32 { \
33 .port = ADC_DT_SPEC_GET(node_id), \
34 .sense_micro_ohms = DT_PROP(node_id, sense_resistor_micro_ohms), \
35 .sense_gain_mult = DT_PROP(node_id, sense_gain_mult), \
36 .sense_gain_div = DT_PROP(node_id, sense_gain_div), \
37 .power_gpio = GPIO_DT_SPEC_GET_OR(node_id, power_gpios, {0}), \
38 }
39
47static inline void
49 int32_t *v_to_i)
50{
51 /* store in a temporary 64 bit variable to prevent overflow during calculation */
52 int64_t tmp = *v_to_i;
53
54 /* multiplies by 1,000,000 before dividing by sense resistance in micro-ohms. */
55 tmp = tmp * 1000000 / spec->sense_micro_ohms * spec->sense_gain_div / spec->sense_gain_mult;
56
57 *v_to_i = (int32_t)tmp;
58}
59
60#endif /* ZEPHYR_INCLUDE_DRIVERS_ADC_CURRENT_SENSE_AMPLIFIER_H_ */
static void current_sense_amplifier_scale_dt(const struct current_sense_amplifier_dt_spec *spec, int32_t *v_to_i)
Calculates the actual amperage from the measured voltage.
Definition: current_sense_amplifier.h:48
ADC public API header file.
Public APIs for GPIO drivers.
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__INT32_TYPE__ int32_t
Definition: stdint.h:74
__INT64_TYPE__ int64_t
Definition: stdint.h:75
Container for ADC channel information specified in devicetree.
Definition: adc.h:264
Definition: current_sense_amplifier.h:13
uint32_t sense_gain_div
Definition: current_sense_amplifier.h:17
const struct adc_dt_spec port
Definition: current_sense_amplifier.h:14
uint32_t sense_gain_mult
Definition: current_sense_amplifier.h:16
uint32_t sense_micro_ohms
Definition: current_sense_amplifier.h:15
struct gpio_dt_spec power_gpio
Definition: current_sense_amplifier.h:18
Container for GPIO pin information specified in devicetree.
Definition: gpio.h:288