Initial Commit

1 files changed, 142 insertions, 0 deletions

diff --git a/ucs2-lib/inc/ucs_i2c_pb.h b/ucs2-lib/inc/ucs_i2c_pb.h
new file mode 100644
index 0000000..2ad1eba
--- /dev/null
+++ b/ucs2-lib/inc/ucs_i2c_pb.h
@@ -0,0 +1,142 @@
+/*------------------------------------------------------------------------------------------------*/
+/* UNICENS V2.1.0-3491                                                                            */
+/* 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.                                              */
+/*------------------------------------------------------------------------------------------------*/
+
+/*!
+ * \file
+ * \brief Public header file of the I2c module.
+ * \addtogroup G_UCS_I2C_TYPES
+ * @{
+ */
+
+#ifndef UCS_I2C_PB_H
+#define UCS_I2C_PB_H
+
+/*------------------------------------------------------------------------------------------------*/
+/* Includes                                                                                       */
+/*------------------------------------------------------------------------------------------------*/
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+/*------------------------------------------------------------------------------------------------*/
+/* Enumerators                                                                                    */
+/*------------------------------------------------------------------------------------------------*/
+/*! \brief Result codes of the I2C Module. */
+typedef enum Ucs_I2c_ResultCode_
+{
+    UCS_I2C_RES_SUCCESS             = 0x00U,   /*!< \brief I2C command succeeded */
+    UCS_I2C_RES_ERR_CMD             = 0x01U,   /*!< \brief I2C command failed due to an INIC function-specific error or a transmission error on the MOST network.
+                                                *  \details The \em result_type section in Ucs_I2c_ResultDetails_t will provide you with more detailed information concerning the error type.
+                                                */
+    UCS_I2C_RES_ERR_SYNC            = 0x02U    /*!< \brief Remote synchronization of target device failed.
+                                                *  \details The \em inic_result section in Ucs_I2c_ResultDetails_t will provide you with more detailed information concerning the error code.
+                                                */
+} Ucs_I2c_ResultCode_t;
+
+/*! \brief This enumerator specifies the kind of result - Target or Transmission. */
+typedef enum Ucs_I2c_ResultType_
+{
+    UCS_I2C_RESULT_TYPE_TGT        = 0x00U,     /*!< \brief Specifies the target results, typically INIC function-specific error from target device. */
+    UCS_I2C_RESULT_TYPE_TX         = 0x01U      /*!< \brief Specifies the transmission error information that occurred on the MOST network. */
+
+} Ucs_I2c_ResultType_t;
+
+/*------------------------------------------------------------------------------------------------*/
+/* Structures                                                                                     */
+/*------------------------------------------------------------------------------------------------*/
+/*! \brief Detailed information used for I2C results. */
+typedef struct Ucs_I2c_ResultDetails_
+{
+    /*! \brief Specifies the type of the current asynchronous result.
+     *  \details The following briefly describes the different types of results available:
+     *              - \b UCS_I2C_RESULT_TYPE_TGT: target results, typically INIC function-specific error found on target device. \n Refer to \em inic_result to get the detailed information.
+     *              - \b UCS_I2C_RESULT_TYPE_TX:  transmission results, typically transmission error on the MOST network. \n Refer to \em tx_result to get the transmission information.
+     */
+    Ucs_I2c_ResultType_t result_type;
+    /*! \brief Holds the status of the transmission. */
+    Ucs_MsgTxStatus_t tx_result;
+    /*! \brief Holds the results of the target device. */
+    Ucs_StdResult_t inic_result;
+
+} Ucs_I2c_ResultDetails_t;
+
+/*! \brief Result structure of the I2C Module. */
+typedef struct Ucs_I2c_Result_
+{
+    /*! \brief Result code. */
+    Ucs_I2c_ResultCode_t code;
+    /*! \brief Detailed information on the returned result. */
+    Ucs_I2c_ResultDetails_t details;
+
+} Ucs_I2c_Result_t;
+
+/*------------------------------------------------------------------------------------------------*/
+/* Type definitions                                                                               */
+/*------------------------------------------------------------------------------------------------*/
+/*! \brief  Callback function type to retrieve the result of the I2c_CreatePort function
+ *  \param  node_address     The node address of the device from where the results come
+ *  \param  i2c_port_handle  The port resource handle.
+ *  \param  result           The operation result
+ *  \param  user_ptr         User reference provided in \ref Ucs_InitData_t "Ucs_InitData_t::user_ptr"
+ */
+typedef void (*Ucs_I2c_CreatePortResCb_t)(uint16_t node_address, uint16_t i2c_port_handle, Ucs_I2c_Result_t result, void *user_ptr);
+
+/*! \brief  Callback function type to retrieve the result of the Gpio_ConfigPinMode function
+ *  \param  node_address        The node address of the device from where the results come
+ *  \param  i2c_port_handle     The port resource handle.
+ *  \param  i2c_slave_address   The 7-bit I2C Port slave address of the peripheral to be read.
+ *  \param  data_len            The number of bytes wrote to the I2C address.
+ *  \param  result              The operation result
+ *  \param  user_ptr            User reference provided in \ref Ucs_InitData_t "Ucs_InitData_t::user_ptr"
+ */
+typedef void (*Ucs_I2c_WritePortResCb_t)(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);
+
+/*! \brief  Callback function type to retrieve the result of the Gpio_ConfigPinMode function
+ *  \param  node_address        The node address of the device from where the results come
+ *  \param  i2c_port_handle     The port resource handle.
+ *  \param  i2c_slave_address   The 7-bit I2C Port slave address of the peripheral from which the data have been read.
+ *  \param  data_len            The number of bytes read from the address.
+ *  \param  data_ptr            The reference to the data list.
+ *  \param  result              The operation result
+ *  \param  user_ptr            User reference provided in \ref Ucs_InitData_t "Ucs_InitData_t::user_ptr"
+ */
+typedef void (*Ucs_I2c_ReadPortResCb_t)(uint16_t node_address, uint16_t i2c_port_handle, uint8_t i2c_slave_address, uint8_t data_len, uint8_t data_ptr[], Ucs_I2c_Result_t result, void *user_ptr);
+
+/*! \brief  Callback function type to report the I2C interrupt event
+ *  \param  node_address     The node address of the device from where the interrupt comes
+ *  \param  user_ptr         User reference provided in \ref Ucs_InitData_t "Ucs_InitData_t::user_ptr"
+ */
+typedef void (*Ucs_I2c_IntEventReportCb_t)(uint16_t node_address, void *user_ptr);
+
+#ifdef __cplusplus
+}   /* extern "C" */
+#endif
+
+#endif  /* #ifndef UCS_I2C_PB_H */
+
+/*! @} */
+
+/*------------------------------------------------------------------------------------------------*/
+/* End of file                                                                                    */
+/*------------------------------------------------------------------------------------------------*/
+