diff options
Diffstat (limited to 'ucs2-interface/ucs-xml/UcsXml.h')
| -rw-r--r-- | ucs2-interface/ucs-xml/UcsXml.h | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/ucs2-interface/ucs-xml/UcsXml.h b/ucs2-interface/ucs-xml/UcsXml.h new file mode 100644 index 0000000..883a9ff --- /dev/null +++ b/ucs2-interface/ucs-xml/UcsXml.h @@ -0,0 +1,94 @@ +/* + * Unicens XML Parser + * + * 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 UCSXML_H_ +#define UCSXML_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stdbool.h> +#include <stdint.h> +#include "ucs_api.h" + +/** Structure holding informations to startup Unicens (UCS). + * Pass all these variables to the UCS manager structure, but not pInternal. + * */ +typedef struct +{ + /** The amount of bytes assigned to the async channel*/ + uint16_t packetBw; + /** Array of routes */ + Ucs_Rm_Route_t *pRoutes; + /** Route array size */ + uint16_t routesSize; + /** Array of nodes */ + Ucs_Rm_Node_t *pNod; + /** Node array size */ + uint16_t nodSize; + /** Internal data, to be ignored */ + void *pInternal; +} UcsXmlVal_t; + +/*>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>*/ +/* Public API */ +/*>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>*/ + +/** + * \brief Initializes Unicens XML parser module, parses the given string and + * generate the data needed to run Unicens (UCS) library. + * + * \note In case of errors the callback UcsXml_CB_OnError will be raised. + * \param xmlString - Zero terminated XML string. The string will not be used + * after this function call. + * \return Structure holding the needed data for UCS. NULL, if there was an error. + * The structure will be created dynamically, to free the data call UcsXml_FreeVal. + */ +UcsXmlVal_t *UcsXml_Parse(const char *xmlString); + +/** + * \brief Frees the given structure, generated by UcsXml_Parse. + * + * \note In case of errors the callback UcsXml_CB_OnError will be raised. + * \param val - The structure to be freed. + */ +void UcsXml_FreeVal(UcsXmlVal_t *val); + +/*>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>*/ +/* CALLBACK SECTION */ +/*>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>*/ + +/** + * \brief Callback whenever a parser error occurs. The message is human readable. + * \note This function must be implemented by the integrator. + * + * \param format - Zero terminated format string (following printf rules) + * \param vargsCnt - Amount of parameters stored in "..." + */ +extern void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...); + +#ifdef __cplusplus +} +#endif + +#endif /* UCSXML_H_ */
\ No newline at end of file |