diff --git a/extras/pcf8574/LICENSE b/extras/pcf8574/LICENSE new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/extras/pcf8574/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/extras/pcf8574/component.mk b/extras/pcf8574/component.mk new file mode 100644 index 0000000..e9235c0 --- /dev/null +++ b/extras/pcf8574/component.mk @@ -0,0 +1,6 @@ +# Component makefile for extras/pcf8574 + +INC_DIRS += $(pcf8574_ROOT).. +pcf8574_SRC_DIR = $(pcf8574_ROOT) + +$(eval $(call component_compile_rules,pcf8574)) diff --git a/extras/pcf8574/pcf8574.c b/extras/pcf8574/pcf8574.c new file mode 100644 index 0000000..04910a8 --- /dev/null +++ b/extras/pcf8574/pcf8574.c @@ -0,0 +1,68 @@ +/* + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + */ +#include "pcf8574.h" +#include + +uint8_t pcf8574_port_read(uint8_t addr) +{ + i2c_start(); + uint8_t res = i2c_write((addr << 1) | 1) ? i2c_read(1) : 0; + i2c_stop(); + return res; +} + +size_t pcf8574_port_read_buf(uint8_t addr, void *buf, size_t len) +{ + if (!len || !buf) return 0; + uint8_t *_buf = (uint8_t *)buf; + + i2c_start(); + if (!i2c_write((addr << 1) | 1)) return 0; + for (size_t i = 0; i < len; i++) + *_buf++ = i2c_read(i == len - 1); + i2c_stop(); + return len; +} + +size_t pcf8574_port_write_buf(uint8_t addr, void *buf, size_t len) +{ + if (!len || !buf) return 0; + uint8_t *_buf = (uint8_t *)buf; + + i2c_start(); + if (!i2c_write(addr << 1)) return 0; + for (size_t i = 0; i < len; i++) + i2c_write(*_buf++); + return len; +} + +void pcf8574_port_write(uint8_t addr, uint8_t value) +{ + i2c_start(); + if (i2c_write(addr << 1)) i2c_write(value); + i2c_stop(); +} + +bool pcf8574_gpio_read(uint8_t addr, uint8_t num) +{ + return (bool)((pcf8574_port_read(addr) >> num) & 1); +} + +void pcf8574_gpio_write(uint8_t addr, uint8_t num, bool value) +{ + uint8_t bit = (uint8_t)value << num; + uint8_t mask = ~(1 << num); + pcf8574_port_write (addr, (pcf8574_port_read(addr) & mask) | bit); +} diff --git a/extras/pcf8574/pcf8574.h b/extras/pcf8574/pcf8574.h new file mode 100644 index 0000000..b2ef9e1 --- /dev/null +++ b/extras/pcf8574/pcf8574.h @@ -0,0 +1,84 @@ +/* + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + */ +/** + * \file Driver for PCF8574 compartible remote 8-bit I/O expanders for I2C-bus + */ +#ifndef PCF8574_PCF8574_H_ +#define PCF8574_PCF8574_H_ + +#include +#include +#include + +#ifdef __cplusplus +extern "C" +{ +#endif + +/** + * \brief Read GPIO port value + * \param addr I2C register address (0b0100 for PCF8574) + * \return 8-bit GPIO port value + */ +uint8_t pcf8574_port_read(uint8_t addr); + +/** + * \brief Continiously read GPIO port values to buffer + * @param addr I2C register address (0b0100 for PCF8574) + * @param buf Target buffer + * @param len Buffer length + * @return Number of bytes read + */ +size_t pcf8574_port_read_buf(uint8_t addr, void *buf, size_t len); + +/** + * \brief Write value to GPIO port + * \param addr I2C register address (0b0100 for PCF8574) + * \param value GPIO port value + */ +void pcf8574_port_write(uint8_t addr, uint8_t value); + +/** + * \brief Continiously write GPIO values to GPIO port + * \param addr I2C register address (0b0100 for PCF8574) + * @param buf Buffer with values + * @param len Buffer length + * @return Number of bytes written + */ +size_t pcf8574_port_write_buf(uint8_t addr, void *buf, size_t len); + +/** + * \brief Read input value of a GPIO pin + * \param addr I2C register address (0b0100 for PCF8574) + * \param num pin number (0..7) + * \return GPIO pin value + */ +bool pcf8574_gpio_read(uint8_t addr, uint8_t num); + +/** + * \brief Set GPIO pin output + * Note it's READ - MODIFY - WRITE operation! Please read PCF8574 + * datasheet first. + * \param addr I2C register address (0b0100 for PCF8574) + * \param num pin number (0..7) + * \param value true for high level + */ +void pcf8574_gpio_write(uint8_t addr, uint8_t num, bool value); + +#ifdef __cplusplus +} +#endif + +#endif /* PCF8574_PCF8574_H_ */