diff options
Diffstat (limited to 'MOST_UNICENS/ucs2-vol/inc')
| -rw-r--r-- | MOST_UNICENS/ucs2-vol/inc/device_container.h | 59 | ||||
| -rw-r--r-- | MOST_UNICENS/ucs2-vol/inc/device_value.h | 104 | ||||
| -rw-r--r-- | MOST_UNICENS/ucs2-vol/inc/libmostvolume.h | 114 | ||||
| -rw-r--r-- | MOST_UNICENS/ucs2-vol/inc/setup.h | 73 |
4 files changed, 0 insertions, 350 deletions
diff --git a/MOST_UNICENS/ucs2-vol/inc/device_container.h b/MOST_UNICENS/ucs2-vol/inc/device_container.h deleted file mode 100644 index 9fabdb5..0000000 --- a/MOST_UNICENS/ucs2-vol/inc/device_container.h +++ /dev/null @@ -1,59 +0,0 @@ -/* - * libmostvolume example - * - * Copyright (C) 2017 Microchip Technology Germany II GmbH & Co. KG - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 2 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * - * You may also obtain this software under a propriety license from Microchip. - * Please contact Microchip for further information. - * - */ - -#ifndef DEVICECONTAINER_H -#define DEVICECONTAINER_H - -#include "device_value.h" -#include "libmostvolume.h" - -class CDeviceContainer { - -public: - CDeviceContainer(); - virtual ~CDeviceContainer(); - - void AssignService(lib_most_volume_init_t *init_ptr) {_init_ptr = init_ptr;} - - void RegisterValues(CDeviceValue** list_pptr, uint16_t list_sz); - void SetValue(uint16_t key, uint8_t value); - void ClearValues(); - void Update(); - void ChangeNodeAvailable(uint16_t address, bool available); - -private: - void RequestService(uint16_t timeout); - void IncrementProcIndex(void); - void HandleI2cResult(uint8_t result); - static void OnI2cResult(uint8_t result, void *obj_ptr); - - uint16_t _idx_processing; - uint16_t _values_sz; - CDeviceValue **_values_pptr; - bool _tx_busy; - bool _service_requested; - lib_most_volume_init_t *_init_ptr; -}; - -#endif /* DEVICECONTAINER_H */ - diff --git a/MOST_UNICENS/ucs2-vol/inc/device_value.h b/MOST_UNICENS/ucs2-vol/inc/device_value.h deleted file mode 100644 index c2fe0b1..0000000 --- a/MOST_UNICENS/ucs2-vol/inc/device_value.h +++ /dev/null @@ -1,104 +0,0 @@ -/* - * libmostvolume example - * - * Copyright (C) 2017 Microchip Technology Germany II GmbH & Co. KG - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 2 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * - * You may also obtain this software under a propriety license from Microchip. - * Please contact Microchip for further information. - * - */ - -#ifndef DEVICEVALUE_H -#define DEVICEVALUE_H - -#include <stdint.h> -#include "libmostvolume.h" - -struct SRxMessage { - uint32_t devInst; /*instance if multiple devices are using the same group id*/ - uint32_t sourceAddr; - uint32_t targetAddr; - uint32_t nFBlock; - uint32_t nInst; - uint32_t nFunc; - uint32_t nOpType; - const uint8_t *pPayload; - uint32_t payloadLen; -}; - -struct STxMessage { - uint32_t devInst; /*instance if multiple devices are using the same group id*/ - uint32_t targetAddr; - uint32_t nFBlock; - uint32_t nInst; - uint32_t nFunc; - uint32_t nOpType; - const uint8_t *pPayload; - uint32_t payloadLen; -}; - -enum DeviceValueType { - DEVICE_VAL_MASTER = 0, - DEVICE_VAL_LEFT = 1, - DEVICE_VAL_RIGHT = 2, - DEVICE_VAL_FIBERDYNE_MASTER = 3 - -}; - -class CDeviceValue { -public: - CDeviceValue(uint16_t address, DeviceValueType type, uint16_t key, bool is_i2c); - virtual ~CDeviceValue(); - - uint16_t GetKey(){return _key;} - DeviceValueType GetType(){return _type;} // returns the assigned type - void SetValue(uint8_t value){_target_value = value;} // sets desired value - - bool RequiresUpdate(); // returns true if target is not actual value - // returns true if success, false if failed - // -> stop transmission - bool FireUpdateMessage(lib_most_volume_writei2c_cb_t writei2c_fptr, - lib_most_volume_writei2c_result_cb_t result_fptr, - void *result_user_ptr);// fires message & updates actual value - bool FireControlMessage(lib_most_volume_sendmessage_cb_t sendmsg_fptr); - - void SetAvailable(bool active){this->_is_available = active; _actual_value = 0x01u;} - bool IsAvailable() {return this->_is_available;} - uint16_t GetAddress() {return this->_address;} - -private: - void ApplyMostValue(uint8_t value, DeviceValueType type, uint8_t tx_payload[]); - void HandleI2cResult(uint8_t result); - static void OnI2cResult(uint8_t result, void *obj_ptr); - - bool _is_available; // related node is available - bool _is_busy; // do not update while busy - bool _is_i2c; - DeviceValueType _type; // determines the remote i2c command - uint16_t _key; // lookup key - uint16_t _address; // target node/group address - uint8_t _target_value; // desired value - uint8_t _transmitted_value;// value pending during transmission - uint8_t _actual_value; // value set and confirmed via network - uint8_t _tx_payload[20]; - uint8_t _tx_payload_sz; - - lib_most_volume_writei2c_result_cb_t _result_fptr; - void *_result_user_ptr; -}; - -#endif /* DEVICEPROPERTY_H */ - diff --git a/MOST_UNICENS/ucs2-vol/inc/libmostvolume.h b/MOST_UNICENS/ucs2-vol/inc/libmostvolume.h deleted file mode 100644 index 5335754..0000000 --- a/MOST_UNICENS/ucs2-vol/inc/libmostvolume.h +++ /dev/null @@ -1,114 +0,0 @@ -/* - * libmostvolume example - * - * Copyright (C) 2017 Microchip Technology Germany II GmbH & Co. KG - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 2 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * - * You may also obtain this software under a propriety license from Microchip. - * Please contact Microchip for further information. - * - */ - -#ifndef LIB_MOST_VOLUME_H -#define LIB_MOST_VOLUME_H - -#include <stdint.h> - - -#ifdef __cplusplus -extern "C" { -#endif - -/** Describes the volume control */ -enum lib_most_volume_channel_t{ - LIB_MOST_VOLUME_CH_FRONT_LEFT = 0, - LIB_MOST_VOLUME_CH_FRONT_RIGHT = 1, - LIB_MOST_VOLUME_CH_REAR_LEFT = 2, - LIB_MOST_VOLUME_CH_REAR_RIGHT = 3, - LIB_MOST_VOLUME_CH_CENTER = 4, - LIB_MOST_VOLUME_CH_SUB = 5, - LIB_MOST_VOLUME_MASTER = 6 -}; - -/** Is fired when the application shall call "lib_most_volume_service()" after a certain time - * \param timeout Time in ms after which the application shall call lib_most_volume_service(). - * Valid values: - * 0x0000: as soon as possible, - * 0x0001..0xFFFE: timeout in ms, - * 0xFFFF: never - */ -typedef void (*lib_most_volume_service_cb_t)(uint16_t timeout); - -typedef void (*lib_most_volume_writei2c_result_cb_t)(uint8_t result, void *user_ptr); - -/** Callback function required to write volume changes to network devices - * \param node The node address - * \param data_ptr I2C command data - * \param data_sz Size of the I2C command data - * \return Returns \c 0 for success, other value on failure. - */ -typedef int (*lib_most_volume_writei2c_cb_t)(uint16_t node, uint8_t *data_ptr, uint8_t data_sz, - lib_most_volume_writei2c_result_cb_t result_fptr, - void *result_user_ptr); - -typedef int (*lib_most_volume_sendmessage_cb_t)(uint16_t node, uint16_t msgid, uint8_t *data_ptr, uint8_t data_sz); - -typedef struct lib_most_volume_init_ { - lib_most_volume_service_cb_t service_cb; - lib_most_volume_writei2c_cb_t writei2c_cb; - lib_most_volume_sendmessage_cb_t sendmsg_cb; - -} lib_most_volume_init_t; - - -/** Initializes the library - * \param UNICENS_inst Reference to the UNICENS instance, created by the application. - * \param req_service_fptr Callback function which is fired if the application shall call - * lib_most_volume_service. - * \return '0' on success, otherwise value >'0'. - */ -extern uint8_t lib_most_volume_init(lib_most_volume_init_t *init_ptr); - -/** Terminates the library - * \return '0' on success, otherwise value >'0'. - */ -extern uint8_t lib_most_volume_exit(void); - -/** Sets a single volume value. - * \param channel The volume control to be set. - * \param volume The volume value to be set. Valid values: 0..255. - * \return '0' on success, otherwise value >'0'. - */ -extern uint8_t lib_most_volume_set(enum lib_most_volume_channel_t channel, uint8_t volume); - -/** Must be called when the availability of a node has changed - * \param address The node address - * \param available Availability: 0 - not available, 1 - available - * \return '0' on success, otherwise value >'0'. - */ -extern uint8_t lib_most_volume_node_available(uint16_t address, uint8_t available); - -/** Shall be called either cyclically (e.g. 50ms -> polling) or after "timeout" - * when "service_fptr" is fired (-> event triggered). - * \return '0' on success, otherwise value >'0'. - */ -extern uint8_t lib_most_volume_service(void); - -#ifdef __cplusplus -} -#endif - -#endif /* LIB_MOST_VOLUME_H */ - diff --git a/MOST_UNICENS/ucs2-vol/inc/setup.h b/MOST_UNICENS/ucs2-vol/inc/setup.h deleted file mode 100644 index 3be8bf4..0000000 --- a/MOST_UNICENS/ucs2-vol/inc/setup.h +++ /dev/null @@ -1,73 +0,0 @@ -/* - * libmostvolume example - * - * Copyright (C) 2017 Microchip Technology Germany II GmbH & Co. KG - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 2 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 General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * - * You may also obtain this software under a propriety license from Microchip. - * Please contact Microchip for further information. - * - */ - -#ifndef SETUP_H -#define SETUP_H - -#include "libmostvolume.h" -#include "device_value.h" -#include "device_container.h" - -#define MAX_CHANNELS (LIB_MOST_VOLUME_MASTER + 1u) -#define MAX_MASTERS 3u - -class CSetup { - -public: - void Configure(lib_most_volume_init_t *init_ptr); - void SetVolume(enum lib_most_volume_channel_t channel, uint8_t volume); - void Update(); - void SetNodeAvailable(uint16_t address, bool available); - -private: - CDeviceValue _volume_amp_270_m; - CDeviceValue _volume_amp_270_l; - CDeviceValue _volume_amp_270_r; - - CDeviceValue _volume_amp_271_m; - CDeviceValue _volume_amp_271_l; - CDeviceValue _volume_amp_271_r; - - CDeviceValue _volume_amp_272_m; - CDeviceValue _volume_amp_272_l; - CDeviceValue _volume_amp_272_r; - - CDeviceValue _volume_amp_510_m; - - CDeviceContainer _value_container; - lib_most_volume_init_t init_data; - -public: - static CSetup* GetInstance(); // singleton - static void Release(); // singleton - -protected: - CSetup(); // singleton - virtual ~CSetup(); // singleton - -private: - static CSetup* _instance; // singleton -}; - -#endif /* SETUP_H */ - |