Initial Commit

6 files changed, 575 insertions, 0 deletions

diff --git a/ucs2-vol/src/CMakeLists.txt b/ucs2-vol/src/CMakeLists.txt
new file mode 100644
index 0000000..8bb406e
--- /dev/null
+++ b/ucs2-vol/src/CMakeLists.txt
@@ -0,0 +1,41 @@
+###########################################################################
+# Copyright 2015, 2016, 2017 IoT.bzh
+#
+# author: Fulup Ar Foll <fulup@iot.bzh>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+###########################################################################
+
+# Add target to project dependency list
+PROJECT_TARGET_ADD(ucs2-vol)
+
+# Define targets source files
+ADD_LIBRARY(ucs2-vol STATIC callbacks.cpp device_container.cpp  device_value.cpp  libmostvolume.cpp  setup.cpp)
+
+    # Expose Library Properties
+    SET_TARGET_PROPERTIES(ucs2-vol PROPERTIES OUTPUT_NAME ucs2vol)
+
+    # Library dependencies from PKG_REQUIRED_LIST
+    TARGET_LINK_LIBRARIES(ucs2-vol     # Library dependencies (include updates automatically)
+        ucs2-lib
+        ${link_libraries}
+    )
+
+    # Define properties to expose when others use this target
+    TARGET_INCLUDE_DIRECTORIES(ucs2-vol 
+       PUBLIC 
+        ${CMAKE_CURRENT_SOURCE_DIR}/../inc
+        ${CMAKE_CURRENT_SOURCE_DIR}/../cfg
+        ${CMAKE_CURRENT_SOURCE_DIR}/ucs-xml
+    )
+
diff --git a/ucs2-vol/src/callbacks.cpp b/ucs2-vol/src/callbacks.cpp
new file mode 100644
index 0000000..353d027
--- /dev/null
+++ b/ucs2-vol/src/callbacks.cpp
@@ -0,0 +1,58 @@
+/*
+ * 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.
+ *
+ */
+
+#include "callbacks.h"
+#include "device_value.h"
+
+typedef void (*i2c_result_t)(Ucs_I2c_Result_t result, void *obj_ptr);
+
+static clb_i2c_result_cb_t i2c_result_fptr;
+static void *i2_obj_ptr;
+
+#define CLB_UNUSED(a)     (a = a)
+
+extern "C" void Clb_RegisterI2CResultCB(clb_i2c_result_cb_t result_fptr, void *obj_ptr)
+{
+    i2c_result_fptr = result_fptr;
+    i2_obj_ptr = obj_ptr;
+}
+
+extern "C" void Clb_OnWriteI2CPortResult(uint16_t node_address, uint16_t i2c_port_handle, uint8_t i2c_slave_address, uint8_t data_len, Ucs_I2c_Result_t result, void *user_ptr)
+{
+    CLB_UNUSED(user_ptr);
+    CLB_UNUSED(data_len);
+    CLB_UNUSED(i2c_slave_address);
+    CLB_UNUSED(i2c_port_handle);
+    CLB_UNUSED(node_address);
+
+    if (i2c_result_fptr != NULL)
+    {
+        clb_i2c_result_cb_t tmp_i2c_result_fptr = i2c_result_fptr;
+        void *tmp_i2_obj_ptr = i2_obj_ptr;
+
+        i2c_result_fptr = NULL;     /* reset references before callback to allow synchronous registration of a new callback */
+        i2_obj_ptr = NULL;
+
+        tmp_i2c_result_fptr(result, tmp_i2_obj_ptr);
+    }
+}
diff --git a/ucs2-vol/src/device_container.cpp b/ucs2-vol/src/device_container.cpp
new file mode 100644
index 0000000..bda3b79
--- /dev/null
+++ b/ucs2-vol/src/device_container.cpp
@@ -0,0 +1,171 @@
+/*
+ * 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.
+ *
+ */
+
+#include "device_container.h"
+#include "callbacks.h"
+#include "ucs_api.h"
+
+#define DEVCONT_TIME_RETRIGGER      (uint16_t)100U
+#define DEVCONT_TIME_NOW            (uint16_t)0U
+#define DEVCONT_TIME_STOP           (uint16_t)0xFFFFU
+
+#define DEVCONT_UNUSED(a)     (a = a)
+
+CDeviceContainer::CDeviceContainer()
+{
+    this->_idx_processing = 0U;
+    this->_ucs_inst_ptr = NULL;
+    this->_values_pptr = NULL;
+    this->_values_sz = 0U;
+    this->_tx_busy = false;
+    this->_service_requested = false;
+    this->_service_fptr = NULL;
+}
+
+CDeviceContainer::~CDeviceContainer()
+{
+    Clb_RegisterI2CResultCB(NULL, NULL);    /* avoid that the result callback is fired after object is destroyed */
+}
+
+void CDeviceContainer::RegisterValues(CDeviceValue** list_pptr, uint16_t list_sz)
+{
+    this->_idx_processing = 0U;
+    this->_values_pptr = list_pptr;
+    this->_values_sz = list_sz;
+    this->_tx_busy = false;
+
+    if ((list_pptr != NULL) && (list_sz > 0U))
+    {
+        this->_idx_processing = list_sz - 1U;
+    }
+}
+
+void CDeviceContainer::ClearValues()
+{
+    this->_idx_processing = 0U;
+    this->_values_pptr = NULL;
+    this->_values_sz = 0U;
+    this->_tx_busy = false;
+}
+
+void CDeviceContainer::SetValue(uint16_t key, uint8_t value)
+{
+     uint16_t idx;
+     bool req_update = false;
+
+     for (idx = 0U; idx < this->_values_sz; idx++)
+     {
+         if (this->_values_pptr[idx]->GetKey() == key)
+         {
+            this->_values_pptr[idx]->SetValue(value);
+            if (this->_values_pptr[idx]->RequiresUpdate())
+            {
+                req_update = true;
+            }
+         }
+     }
+
+    if (req_update && (!this->_tx_busy))
+    {
+        RequestService(DEVCONT_TIME_NOW); //fire callback
+    }
+}
+
+void CDeviceContainer::IncrementProcIndex(void)
+{
+    if ((_idx_processing + 1U) >=  this->_values_sz)
+    {
+        _idx_processing = 0U;
+    }
+    else
+    {
+        _idx_processing++;
+    }
+}
+
+// starts at latest position, searches next value to update, waits until response
+void CDeviceContainer::Update()
+{
+    uint16_t cnt;
+    bool error = false;
+    _service_requested = false;
+
+    if (this->_ucs_inst_ptr == NULL)
+    {
+        return;
+    }
+
+    if (this->_tx_busy)
+    {
+        return;
+    }
+    
+    for (cnt = 0u; cnt < this->_values_sz; cnt++)   /* just run one cycle */
+    {
+        IncrementProcIndex();
+
+        if (_values_pptr[_idx_processing]->RequiresUpdate())
+        {
+            if (_values_pptr[_idx_processing]->FireUpdateMessage())
+            {
+                Clb_RegisterI2CResultCB(&OnI2cResult, this);
+                this->_tx_busy = true;
+                break;
+            }
+            else
+            {
+                error = true;
+            }
+        }
+    }
+
+    if (error)
+    {
+        RequestService(DEVCONT_TIME_RETRIGGER);
+    }
+}
+
+void CDeviceContainer::HandleI2cResult(Ucs_I2c_Result_t result)
+{
+    DEVCONT_UNUSED(result);
+    this->_tx_busy = false;
+    this->RequestService(DEVCONT_TIME_NOW);
+}
+
+void CDeviceContainer::OnI2cResult(Ucs_I2c_Result_t result, void *obj_ptr)
+{
+    ((CDeviceContainer*)obj_ptr)->HandleI2cResult(result);
+}
+
+void CDeviceContainer::RequestService(uint16_t timeout)
+{
+    if (!_service_requested)
+    {
+        _service_requested = true;
+
+        if (_service_fptr != NULL)
+        {
+            _service_fptr(timeout);
+        }
+    }
+}
diff --git a/ucs2-vol/src/device_value.cpp b/ucs2-vol/src/device_value.cpp
new file mode 100644
index 0000000..5a1ad5c
--- /dev/null
+++ b/ucs2-vol/src/device_value.cpp
@@ -0,0 +1,125 @@
+/*
+ * 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.
+ *
+ */
+
+#include "device_value.h"
+#include "callbacks.h"
+#include "ucs_api.h"
+#include "setup.h"
+/*#include <iostream>*/
+
+#define MUTE_VALUE      0x03FFU
+#define MUTE_VALUE_HB   0x03U
+#define MUTE_VALUE_LB   0xFFU
+
+#define CONTROL_MASTER  0x07U
+#define CONTROL_CH_1    0x08U
+#define CONTROL_CH_2    0x09U
+
+CDeviceValue::CDeviceValue(uint16_t address, DeviceValueType type, uint16_t key) 
+{
+    this->_is_initial = true;
+    this->_address = address;
+    this->_target_value = 0x01u;
+    this->_actual_value = 0x01u;
+    
+    this->_type = type;
+    this->_key = key;
+    
+    _tx_payload[0] = CONTROL_MASTER;// 7: master, 8: channel 1, 9: Channel 2
+    _tx_payload[1] = MUTE_VALUE_HB; //HB:Volume
+    _tx_payload[2] = MUTE_VALUE_LB; //LB:Volume
+    _tx_payload_sz = 3u;
+}
+
+CDeviceValue::~CDeviceValue() 
+{
+}
+
+void CDeviceValue::ApplyMostValue(uint8_t value, DeviceValueType type, uint8_t tx_payload[])
+{
+    uint16_t tmp = MUTE_VALUE;
+    
+    switch (type) 
+    {
+        case DEVICE_VAL_LEFT:
+            tmp = 0x80U + 0x37FU - (0x37FU * ((int32_t)value) / (0xFFU));
+            //tmp = 0x3FF - (0x3FF * ((int32_t)value) / (0xFF));
+            //tmp = 0x100 + 0x2FF - (0x2FF * ((int32_t)value) / (0xFF));
+            tx_payload[0] = CONTROL_CH_1;
+            break;
+        case DEVICE_VAL_RIGHT:
+            tmp = 0x80U + 0x37FU - (0x37FU * ((int32_t)value) / (0xFFU));
+            //tmp = 0x3FF - (0x3FF * ((int32_t)value) / (0xFF));
+            //tmp = 0x100 + 0x2FF - (0x2FF * ((int32_t)value) / (0xFF));
+            tx_payload[0] = CONTROL_CH_2;
+            break;
+        default:
+            /*std::cerr << "CDeviceValue::ApplyMostValue() error matching incorrect" << std::endl;*/
+        case DEVICE_VAL_MASTER:
+            tmp = 0x100U + 0x2FFU - (0x2FFU * ((int32_t)value) / (0xFFU));
+            tx_payload[0] = CONTROL_MASTER;
+            break;
+    }
+    
+    tx_payload[1] = (uint8_t)((tmp >> 8U) & (uint16_t)0xFFU); //HB:Volume
+    tx_payload[2] = (uint8_t)(tmp  & (uint16_t)0xFFU); //LB:Volume
+}
+
+// returns true if target is not actual value
+bool CDeviceValue::RequiresUpdate() 
+{
+    if (this->_target_value != this->_actual_value) 
+    {
+        return true;
+    }
+    
+    return false;
+}
+
+bool CDeviceValue::FireUpdateMessage(void)
+{
+    Ucs_Return_t ret;
+    ApplyMostValue(this->_target_value, _type, _tx_payload);
+
+    ret = Ucs_I2c_WritePort( CSetup::GetInstance()->RetrieveUnicensInst(),
+            this->_address,
+            0x0F00u,                /* i2c port handle */
+            UCS_I2C_DEFAULT_MODE,   /* 0 */
+            0u,                     /* block count */
+            0x2Au,                  /* i2c slave address */
+            0x03E8u,                /* timeout 1000 milliseconds */
+            _tx_payload_sz,         /* data length */
+            &_tx_payload[0],        /* data pointer */
+            &Clb_OnWriteI2CPortResult
+            );
+
+    if (ret == UCS_RET_SUCCESS)
+    {
+        // Clb_RegisterI2CResultCB(OnI2cResult, this);
+        // mark value as set!
+        this->_actual_value = this->_target_value;
+        return true;
+    }
+
+    return false;
+}
diff --git a/ucs2-vol/src/libmostvolume.cpp b/ucs2-vol/src/libmostvolume.cpp
new file mode 100644
index 0000000..4581be7
--- /dev/null
+++ b/ucs2-vol/src/libmostvolume.cpp
@@ -0,0 +1,86 @@
+/*
+ * 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.
+ *
+ */
+
+#include "libmostvolume.h"
+#include "setup.h"
+/*#include <iostream>*/
+
+static bool _running = false;
+
+extern "C" uint8_t lib_most_volume_init(Ucs_Inst_t *unicens_inst, lib_most_volume_service_cb_t req_service_fptr)
+{
+    uint8_t success = 1U;
+    /*std::cerr << "lib_most_volume_init(): called" << std::endl;*/
+
+    if (!_running)
+    {
+        CSetup::GetInstance()->Configure(unicens_inst, req_service_fptr);
+        success = 0U;
+        _running = true;
+    }
+
+    return success;
+}
+
+extern "C" uint8_t lib_most_volume_exit(void)
+{
+    uint8_t success = 1U;
+    /*std::cerr << "lib_most_volume_exit(): called" << std::endl;*/
+
+    if (_running)
+    {
+        CSetup::Release();
+        success = 0U;
+        _running = false;
+    }
+
+    return success;
+}
+
+extern "C" uint8_t lib_most_volume_set(enum lib_most_volume_channel_t channel, uint8_t volume)
+{
+    uint8_t success = 1U;
+    /*std::cerr << "lib_most_volume_set(): channel=" << channel << ", volume=" << (int)volume << std::endl;*/
+
+    if (_running)
+    {
+        CSetup::GetInstance()->SetVolume(channel, volume);
+        success = 0U;
+    }
+
+    return success;
+}
+
+extern "C" uint8_t lib_most_volume_service(void)
+{   
+    uint8_t success = 1U;
+    /*std::cerr << "lib_most_volume_service(): called" << std::endl;*/
+
+    if (_running)
+    {
+        CSetup::GetInstance()->Update();
+        success = 0U;
+    }
+    
+    return success;
+}
\ No newline at end of file
diff --git a/ucs2-vol/src/setup.cpp b/ucs2-vol/src/setup.cpp
new file mode 100644
index 0000000..5ff3d79
--- /dev/null
+++ b/ucs2-vol/src/setup.cpp
@@ -0,0 +1,94 @@
+/*
+ * 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.
+ *
+ */
+
+#include "setup.h"
+
+CSetup* CSetup::_instance = NULL;
+
+// singleton
+CSetup* CSetup::GetInstance() {
+    if (_instance == NULL) {
+        _instance = new CSetup();        
+    }
+    
+    return _instance;
+}
+
+// singleton
+void CSetup::Release() {
+    if (_instance != NULL) {
+        delete _instance;
+    }
+    _instance = NULL;
+}
+
+CSetup::CSetup()
+    :   _volume_amp_270_m(0x270U, DEVICE_VAL_MASTER, LIB_MOST_VOLUME_MASTER),
+        _volume_amp_270_l(0x270U, DEVICE_VAL_LEFT, LIB_MOST_VOLUME_CH_FRONT_LEFT),
+        _volume_amp_270_r(0x270U, DEVICE_VAL_RIGHT, LIB_MOST_VOLUME_CH_FRONT_RIGHT),
+        _volume_amp_271_m(0x271U, DEVICE_VAL_MASTER, LIB_MOST_VOLUME_MASTER),
+        _volume_amp_271_l(0x271U, DEVICE_VAL_LEFT, LIB_MOST_VOLUME_CH_REAR_LEFT),
+        _volume_amp_271_r(0x271U, DEVICE_VAL_RIGHT, LIB_MOST_VOLUME_CH_REAR_RIGHT),
+        _volume_amp_272_m(0x272U, DEVICE_VAL_MASTER, LIB_MOST_VOLUME_MASTER),
+        _volume_amp_272_l(0x272U, DEVICE_VAL_LEFT, LIB_MOST_VOLUME_CH_CENTER),
+        _volume_amp_272_r(0x272U, DEVICE_VAL_RIGHT, LIB_MOST_VOLUME_CH_SUB),
+        _value_container()
+{    
+    static CDeviceValue* value_list[3] = {  &_volume_amp_270_m,
+                                            &_volume_amp_270_l,
+                                            &_volume_amp_270_r/*,
+                                            &_volume_amp_271_m,
+                                            &_volume_amp_271_l,
+                                            &_volume_amp_271_r,
+                                            &_volume_amp_272_m,
+                                            &_volume_amp_272_l,
+                                            &_volume_amp_272_r*/};
+
+    _value_container.RegisterValues(value_list, 3U);
+}
+
+CSetup::~CSetup()
+{
+
+}
+
+void CSetup::Configure(Ucs_Inst_t *unicens_inst, lib_most_volume_service_cb_t service_fptr)
+{
+    ucs_inst = unicens_inst;
+    _value_container.AssignService(service_fptr, unicens_inst);
+}
+
+Ucs_Inst_t* CSetup::RetrieveUnicensInst(void)
+{
+    return ucs_inst;
+}
+
+void CSetup::SetVolume(enum lib_most_volume_channel_t channel, uint8_t volume)
+{
+    _value_container.SetValue((uint16_t)channel, volume);
+}
+
+void CSetup::Update()
+{
+    _value_container.Update();
+}
\ No newline at end of file