charger.h

Go to the documentation of this file.

/*
 * Copyright 2023 Cirrus Logic, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_CHARGER_H_
#define ZEPHYR_INCLUDE_DRIVERS_CHARGER_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
enum charger_property {
        CHARGER_PROP_ONLINE = 0,
        CHARGER_PROP_PRESENT,
        CHARGER_PROP_STATUS,
        CHARGER_PROP_COMMON_COUNT,
        CHARGER_PROP_CUSTOM_BEGIN = CHARGER_PROP_COMMON_COUNT + 1,
        CHARGER_PROP_MAX = UINT16_MAX,
};
 
typedef uint16_t charger_prop_t;
 
enum charger_online {
        CHARGER_ONLINE_OFFLINE = 0,
        CHARGER_ONLINE_FIXED,
        CHARGER_ONLINE_PROGRAMMABLE,
};
 
enum charger_status {
        CHARGER_STATUS_UNKNOWN = 0,
        CHARGER_STATUS_CHARGING,
        CHARGER_STATUS_DISCHARGING,
        CHARGER_STATUS_NOT_CHARGING,
        CHARGER_STATUS_FULL,
};
 
union charger_propval {
        /* Fields have the format: */
        /* CHARGER_PROPERTY_FIELD */
        /* type property_field; */
 
        enum charger_online online;
        bool present;
        enum charger_status status;
};
 
typedef int (*charger_get_property_t)(const struct device *dev, const charger_prop_t prop,
                                      union charger_propval *val);
 
typedef int (*charger_set_property_t)(const struct device *dev, const charger_prop_t prop,
                                      const union charger_propval *val);
 
__subsystem struct charger_driver_api {
        charger_get_property_t get_property;
        charger_set_property_t set_property;
};
 
__syscall int charger_get_prop(const struct device *dev, const charger_prop_t prop,
                               union charger_propval *val);
 
static inline int z_impl_charger_get_prop(const struct device *dev, const charger_prop_t prop,
                                          union charger_propval *val)
{
        const struct charger_driver_api *api = (const struct charger_driver_api *)dev->api;
 
        return api->get_property(dev, prop, val);
}
 
__syscall int charger_set_prop(const struct device *dev, const charger_prop_t prop,
                               const union charger_propval *val);
 
static inline int z_impl_charger_set_prop(const struct device *dev, const charger_prop_t prop,
                                          const union charger_propval *val)
{
        const struct charger_driver_api *api = (const struct charger_driver_api *)dev->api;
 
        return api->set_property(dev, prop, val);
}
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#include <syscalls/charger.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_CHARGER_H_ */