Zephyr API Documentation  3.7.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
current_sense_shunt.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_SHUNT_H_
8#define ZEPHYR_INCLUDE_DRIVERS_ADC_CURRENT_SENSE_SHUNT_H_
9
10#include <zephyr/drivers/adc.h>
11
13 const struct adc_dt_spec port;
15};
16
27#define CURRENT_SENSE_SHUNT_DT_SPEC_GET(node_id) \
28 { \
29 .port = ADC_DT_SPEC_GET(node_id), \
30 .shunt_micro_ohms = DT_PROP(node_id, shunt_resistor_micro_ohms), \
31 }
32
40static inline void current_sense_shunt_scale_dt(const struct current_sense_shunt_dt_spec *spec,
41 int32_t *v_to_i)
42{
43 /* store in a temporary 64 bit variable to prevent overflow during calculation */
44 int64_t tmp = *v_to_i;
45
46 /* multiplies by 1,000,000 before dividing by shunt resistance in micro-ohms. */
47 tmp = tmp * 1000000 / spec->shunt_micro_ohms;
48
49 *v_to_i = (int32_t)tmp;
50}
51
52#endif /* ZEPHYR_INCLUDE_DRIVERS_ADC_CURRENT_SENSE_SHUNT_H_ */
static void current_sense_shunt_scale_dt(const struct current_sense_shunt_dt_spec *spec, int32_t *v_to_i)
Calculates the actual amperage from the measured voltage.
Definition: current_sense_shunt.h:40
ADC public API header file.
__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_shunt.h:12
const struct adc_dt_spec port
Definition: current_sense_shunt.h:13
uint32_t shunt_micro_ohms
Definition: current_sense_shunt.h:14