From 3cd7558a5e128714b367f234dc7da6088d656ac2 Mon Sep 17 00:00:00 2001 From: Alan Carvalho de Assis Date: Sat, 19 Sep 2015 13:06:43 -0600 Subject: [PATCH] Add basic infrastructure for Battery Charger --- drivers/power/Kconfig | 5 + drivers/power/Make.defs | 4 + drivers/power/battery_charger.c | 275 ++++++++++++++++++++++++++ include/nuttx/power/battery_charger.h | 238 ++++++++++++++++++++++ 4 files changed, 522 insertions(+) create mode 100644 drivers/power/battery_charger.c create mode 100644 include/nuttx/power/battery_charger.h diff --git a/drivers/power/Kconfig b/drivers/power/Kconfig index cb7c870565..6e9292a568 100644 --- a/drivers/power/Kconfig +++ b/drivers/power/Kconfig @@ -2,6 +2,11 @@ # For a description of the syntax of this configuration file, # see the file kconfig-language.txt in the NuttX tools repository. # + +config BATTERY_CHARGER + bool "Battery Charger support" + default n + config BATTERY_GAUGE bool "Battery Fuel Gauge support" default n diff --git a/drivers/power/Make.defs b/drivers/power/Make.defs index a28ac6255f..0fc143d83a 100644 --- a/drivers/power/Make.defs +++ b/drivers/power/Make.defs @@ -53,6 +53,10 @@ endif # Add battery drivers +ifeq ($(CONFIG_BATTERY_CHARGER),y) +CSRCS += battery_charger.c +endif + ifeq ($(CONFIG_BATTERY_GAUGE),y) CSRCS += battery_gauge.c diff --git a/drivers/power/battery_charger.c b/drivers/power/battery_charger.c new file mode 100644 index 0000000000..1e12f7dd2c --- /dev/null +++ b/drivers/power/battery_charger.c @@ -0,0 +1,275 @@ +/**************************************************************************** + * drivers/power/battery_charger.c + * Upper-half, character driver for batteries charger. + * + * Copyright (C) 2015 Alan Carvalho de Assis. All rights reserved. + * Author: Alan Carvalho de Assis + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include + +#include +#include +#include +#include + +#include +#include + +/* This driver requires: + * + * CONFIG_BATTERY_CHARGER - Upper half battery driver support + */ + +#if defined(CONFIG_BATTERY_CHARGER) + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +/**************************************************************************** + * Private + ****************************************************************************/ + +/**************************************************************************** + * Private Function Prototypes + ****************************************************************************/ + +/* Character driver methods */ + +static int bat_charger_open(FAR struct file *filep); +static int bat_charger_close(FAR struct file *filep); +static ssize_t bat_charger_read(FAR struct file *, FAR char *, + size_t nbytes); +static ssize_t bat_charger_write(FAR struct file *filep, + FAR const char *buffer, size_t buflen); +static int bat_charger_ioctl(FAR struct file *filep, int cmd, + unsigned long arg); + +/**************************************************************************** + * Private Data + ****************************************************************************/ + +static const struct file_operations g_batteryops = +{ + bat_charger_open, + bat_charger_close, + bat_charger_read, + bat_charger_write, + 0, + bat_charger_ioctl +#ifndef CONFIG_DISABLE_POLL + , 0 +#endif +}; + +/**************************************************************************** + * Private Functions + ****************************************************************************/ +/**************************************************************************** + * Name: bat_charger_open + * + * Description: + * This function is called whenever the battery device is opened. + * + ****************************************************************************/ + +static int bat_charger_open(FAR struct file *filep) +{ + return OK; +} + +/**************************************************************************** + * Name: bat_charger_close + * + * Description: + * This routine is called when the battery device is closed. + * + ****************************************************************************/ + +static int bat_charger_close(FAR struct file *filep) +{ + return OK; +} + +/**************************************************************************** + * Name: bat_charger_read + ****************************************************************************/ + +static ssize_t bat_charger_read(FAR struct file *filep, FAR char *buffer, + size_t buflen) +{ + /* Return nothing read */ + + return 0; +} + +/**************************************************************************** + * Name: bat_charger_write + ****************************************************************************/ + +static ssize_t bat_charger_write(FAR struct file *filep, + FAR const char *buffer, size_t buflen) +{ + /* Return nothing written */ + + return 0; +} + +/**************************************************************************** + * Name: bat_charger_ioctl + ****************************************************************************/ + +static int bat_charger_ioctl(FAR struct file *filep, int cmd, + unsigned long arg) +{ + FAR struct inode *inode = filep->f_inode; + FAR struct battery_charger_dev_s *dev = inode->i_private; + int ret; + + /* Inforce mutually exclusive access to the battery driver */ + + ret = sem_wait(&dev->batsem); + if (ret < 0) + { + return -errno; /* Probably EINTR */ + } + + /* Procss the IOCTL command */ + + ret = -EINVAL; /* Assume a bad argument */ + switch (cmd) + { + case BATIOC_STATE: + { + FAR int *ptr = (FAR int *)((uintptr_t)arg); + if (ptr) + { + ret = dev->ops->state(dev, ptr); + } + } + break; + + case BATIOC_HEALTH: + { + FAR int *ptr = (FAR int *)((uintptr_t)arg); + if (ptr) + { + ret = dev->ops->health(dev, ptr); + } + } + break; + + case BATIOC_ONLINE: + { + FAR bool *ptr = (FAR bool *)((uintptr_t)arg); + if (ptr) + { + ret = dev->ops->online(dev, ptr); + } + } + break; + + case BATIOC_VOLTAGE: + { + int volts; + FAR int *voltsp = (FAR int *)((uintptr_t)arg); + volts = *voltsp; + if (ptr) + { + ret = dev->ops->voltage(dev, volts); + } + } + break; + + case BATIOC_CURRENT: + { + int amps; + FAR int *ampsp = (FAR int *)((uintptr_t)arg); + amps = *ampsp; + if (ptr) + { + ret = dev->ops->current(dev, amps); + } + } + break; + + default: + dbg("Unrecognized cmd: %d\n", cmd); + ret = -ENOTTY; + break; + } + + sem_post(&dev->batsem); + return ret; +} + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: battery_charger_register + * + * Description: + * Register a lower half battery driver with the common, upper-half + * battery driver. + * + * Input parameters: + * devpath - The location in the pseudo-filesystem to create the driver. + * Recommended standard is "/dev/bat0", "/dev/bat1", etc. + * dev - An instance of the battery state structure . + * + * Returned value: + * Zero on success or a negated errno value on failure. + * + ****************************************************************************/ + +int battery_charger_register(FAR const char *devpath, + FAR struct battery_charger_dev_s *dev) +{ + int ret; + + /* Register the character driver */ + + ret = register_driver(devpath, &g_batteryops, 0555, dev); + if (ret < 0) + { + dbg("Failed to register driver: %d\n", ret); + } + + return ret; +} +#endif /* CONFIG_BATTERY_CHARGER */ diff --git a/include/nuttx/power/battery_charger.h b/include/nuttx/power/battery_charger.h new file mode 100644 index 0000000000..fadb331b21 --- /dev/null +++ b/include/nuttx/power/battery_charger.h @@ -0,0 +1,238 @@ +/**************************************************************************** + * include/nuttx/power/battery_charger.h + * NuttX Battery Charger Interfaces + * + * Copyright (C) 2012, 2015 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +#ifndef __INCLUDE_NUTTX_POWER_BATTERY_CHARGER_H +#define __INCLUDE_NUTTX_POWER_BATTERY_CHARGER_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include +#include + +#include +#include +#include + +#ifdef CONFIG_BATTERY_CHARGER + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ +/* Configuration ************************************************************/ +/* CONFIG_BATTERY_CHARGER - Upper half battery charger driver support + * + * Specific, lower-half drivers will have other configuration requirements + * such as: + * + * CONFIG_I2C - I2C support *may* be needed + * CONFIG_I2C_BQ2425X - The BQ2425x driver must be explicitly selected. + */ + +/* IOCTL Commands ***********************************************************/ +/* The upper-half battery charger driver provides a character driver "wrapper" + * around the lower-half battery charger driver that does all of the real work. + * Since there is no real data transfer to/or from a battery, all of the + * driver interaction is through IOCTL commands. The IOCTL commands + * supported by the upper-half driver simply provide calls into the the + * lower half as summarized below: + * + * BATIOC_STATE - Return the current state of the battery (see + * enum battery_charger_status_e). + * Input value: A pointer to type int. + * BATIOC_HEALTH - Return the current health of the battery (see + * enum battery_charger_health_e). + * Input value: A pointer to type int. + * BATIOC_ONLINE - Return 1 if the battery is online; 0 if offline. + * Input value: A pointer to type bool. + * BATIOC_VOLTAGE - Define the wished charger voltage to charge the battery. + * Input value: An int defining the voltage value. + */ + +#define BATIOC_STATE _BATIOC(0x0001) +#define BATIOC_HEALTH _BATIOC(0x0002) +#define BATIOC_ONLINE _BATIOC(0x0003) +#define BATIOC_VOLTAGE _BATIOC(0x0004) +#define BATIOC_CURRENT _BATIOC(0x0005) + +/**************************************************************************** + * Public Types + ****************************************************************************/ +/* Battery status */ + +enum battery_charger_status_e +{ + BATTERY_UNKNOWN = 0, /* Battery state is not known */ + BATTERY_IDLE, /* Not full, not charging, not discharging */ + BATTERY_FULL, /* Full, not discharging */ + BATTERY_CHARGING, /* Not full, charging */ + BATTERY_DISCHARGING /* Probably not full, discharging */ +}; + +/* Battery Health status */ + +enum battery_charger_health_e +{ + BATTERY_HEALTH_UNKNOWN = 0, /* Battery health state is not known */ + BATTERY_HEALTH_GOOD, /* Battery is in good condiction */ + BATTERY_HEALTH_DEAD, /* Battery is dead, nothing we can do */ + BATTERY_HEALTH_OVERHEAT, /* Battery is over recommended temperature */ + BATTERY_HEALTH_OVERVOLTAGE, /* Battery voltage is over recommended level */ + BATTERY_HEALTH_UNSPEC_FAIL, /* Battery charger reported an unspected failure */ + BATTERY_HEALTH_COLD, /* Battery is under recommended temperature */ + BATTERY_HEALTH_WD_TMR_EXP, /* Battery WatchDog Timer Expired */ + BATTERY_HEALTH_SAFE_TMR_EXP /* Battery Safety Timer Expired */ +}; + + /* This structure defines the lower half battery interface */ + +struct battery_charger_dev_s; +struct battery_charger_operations_s +{ + /* Return the current battery state (see enum battery_charger_status_e) */ + + int (*state)(struct battery_charger_dev_s *dev, int *status); + + /* Return the current battery health (see enum battery_charger_health_e) */ + + int (*health)(struct battery_charger_dev_s *dev, int *health); + + /* Return true if the batter is online */ + + int (*online)(struct battery_charger_dev_s *dev, bool *status); + + /* Set the wished battery voltage for charging */ + + int (*voltage)(struct battery_charger_dev_s *dev, int value); + + /* Set the wished current rate used for charging */ + + int (*current)(struct battery_charger_dev_s *dev, int value); +}; + +/* This structure defines the battery driver state structure */ + +struct battery_charger_dev_s +{ + /* Fields required by the upper-half driver */ + + FAR const struct battery_charger_operations_s *ops; /* Battery operations */ + sem_t batsem; /* Enforce mutually exclusive access */ + + /* Data fields specific to the lower-half driver may follow */ +}; + +/**************************************************************************** + * Public Data + ****************************************************************************/ + +#ifndef __ASSEMBLY__ + +#ifdef __cplusplus +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ +/**************************************************************************** + * Name: battery_charger_register + * + * Description: + * Register a lower half battery driver with the common, upper-half + * battery driver. + * + * Input parameters: + * devpath - The location in the pseudo-filesystem to create the driver. + * Recommended standard is "/dev/bat0", "/dev/bat1", etc. + * dev - An instance of the battery state structure . + * + * Returned value: + * Zero on success or a negated errno value on failure. + * + ****************************************************************************/ + +int battery_charger_register(FAR const char *devpath, + FAR struct battery_charger_dev_s *dev); + +/**************************************************************************** + * Name: bq2425x_initialize + * + * Description: + * Initialize the BQ2425X battery driver and return an instance of the + * lower_half interface that may be used with battery_charger_register(); + * + * This driver requires: + * + * CONFIG_BATTERY_CHARGER - Upper half battery fuel gauge driver support + * CONFIG_I2C - I2C support + * CONFIG_I2C_BQ2425X - And the driver must be explictly selected. + * CONFIG_I2C_BQ24250 or CONFIG_I2C_BQ24251 - The driver must know which + * chip is on the board in order to scale the voltage correctly. + * + * Input Parameters: + * i2c - An instance of the I2C interface to use to communicate with + * the BQ2425X + * addr - The I2C address of the BQ2425X (Better be 0x6A). + * frequency - The I2C frequency + * + * Returned Value: + * A pointer to the initializeed battery driver instance. A NULL pointer + * is returned on a failure to initialize the BQ2425X lower half. + * + ****************************************************************************/ + +#if defined(CONFIG_I2C) && defined(CONFIG_I2C_BQ2425X) +struct i2c_dev_s; /* Forward reference */ + +FAR struct battery_charger_dev_s *bq2425x_initialize(FAR struct i2c_dev_s *i2c + uint8_t addr, + uint32_t frequency); +#endif + +#undef EXTERN +#ifdef __cplusplus +} +#endif + +#endif /* __ASSEMBLY__ */ +#endif /* CONFIG_BATTERY_CHARGER */ +#endif /* __INCLUDE_NUTTX_POWER_BATTERY_H */