diff options
Diffstat (limited to 'ucs2-lib/inc/ucs_nsm_pb.h')
| -rw-r--r-- | ucs2-lib/inc/ucs_nsm_pb.h | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/ucs2-lib/inc/ucs_nsm_pb.h b/ucs2-lib/inc/ucs_nsm_pb.h new file mode 100644 index 0000000..9062360 --- /dev/null +++ b/ucs2-lib/inc/ucs_nsm_pb.h @@ -0,0 +1,136 @@ +/*------------------------------------------------------------------------------------------------*/ +/* 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 Node Script Management. + */ + +#ifndef UCS_NSM_PB_H +#define UCS_NSM_PB_H + +/*------------------------------------------------------------------------------------------------*/ +/* Includes */ +/*------------------------------------------------------------------------------------------------*/ +#include "ucs_rules.h" +#include "ucs_rm_pv.h" + +#ifdef __cplusplus +extern "C" +{ +#endif + +/*------------------------------------------------------------------------------------------------*/ +/* Enumerators */ +/*------------------------------------------------------------------------------------------------*/ +/*! \brief Result codes of the Node Script Management. + * \ingroup G_UCS_SCRIPTING + */ +typedef enum Ucs_Ns_ResultCode_ +{ + UCS_NS_RES_SUCCESS = 0x00U, /*!< \brief Transmission of script(s) was successful. */ + UCS_NS_RES_ERROR = 0x01U /*!< \brief Transmission of script(s) failed. */ + +} Ucs_Ns_ResultCode_t; + +/*------------------------------------------------------------------------------------------------*/ +/* Structures */ +/*------------------------------------------------------------------------------------------------*/ +/*! \brief Structure of a ConfigMsg used in Node-Script. + * \ingroup G_UCS_SCRIPTING + */ +typedef struct Ucs_Ns_ConfigMsg_ +{ + /*! \brief FBlockId of the config msg. */ + uint8_t FBlockId; + /*! \brief InstId of the config msg. */ + uint8_t InstId; + /*! \brief FunktId of the config msg. */ + uint16_t FunktId; + /*! \brief OpCode of the config msg. */ + uint8_t OpCode; + /*! \brief Data length. */ + uint8_t DataLen; + /*! \brief Reference to the Data */ + uint8_t * DataPtr; + +} Ucs_Ns_ConfigMsg_t; + +/*! \brief Structure of a node-script used to configure a remote node. + * \attention The Node Scripting module is designed and intended for the use of \b I2C and \b GPIO commands only. That is, using the Scripting for any other FBlock INIC commands + * (for example MOST, MediaLB, USB, Streaming, Connections, etc.) is expressly \b prohibited. + * \ingroup G_UCS_SCRIPTING + */ +typedef struct Ucs_Ns_Script_ +{ + /*! \brief Specifies the pause which shall be set before sending + * the configuration message. + */ + uint16_t pause; + /*! \brief Command to be transmitted. */ + Ucs_Ns_ConfigMsg_t * send_cmd; + /*! \brief Expected result. */ + Ucs_Ns_ConfigMsg_t * exp_result; + +} Ucs_Ns_Script_t; + +/*! \brief Configuration structure of a Node. + * + * \attention Use the \ref UCS_ADDR_LOCAL_DEV macro to address your local device when specifying routes to/from It. + * \n The following address ranges are supported: + * - [0x10 ... 0x2FF] + * - [0x500 ... 0xFEF] + * - UCS_ADDR_LOCAL_DEV + * \ingroup G_UCS_ROUTING_TYPES + */ +typedef struct Ucs_Rm_Node_ +{ + /*! \brief node signature. */ + Ucs_Signature_t * signature_ptr; + /*! \brief Reference to a list of configuration scripts. */ + Ucs_Ns_Script_t * script_list_ptr; + /*! \brief size of the scripts table. */ + uint8_t script_list_size; + /*! \brief Internal information of this node object. */ + Ucs_Rm_NodeInt_t internal_infos; + +} Ucs_Rm_Node_t; + +/*------------------------------------------------------------------------------------------------*/ +/* Type definitions */ +/*------------------------------------------------------------------------------------------------*/ +/*! \brief Function signature used for the results of the Scripting Manager. + * \param node_ptr Reference to the node instance + * \param result Result of the scripting operation. + * \param ucs_user_ptr User reference for API callback functions. + * \ingroup G_UCS_SCRIPTING + */ +typedef void (*Ucs_Ns_ResultCb_t)(Ucs_Rm_Node_t * node_ptr, Ucs_Ns_ResultCode_t result, void *ucs_user_ptr); + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /* #ifndef UCS_NSM_PB_H */ +/*------------------------------------------------------------------------------------------------*/ +/* End of file */ +/*------------------------------------------------------------------------------------------------*/ + |