summaryrefslogtreecommitdiffstats
path: root/ucs2-interface/ucs-xml/UcsXml.h
diff options
context:
space:
mode:
authortkummermehr <thorsten.kummermehr@k2l.de>2017-07-14 09:48:01 +0200
committerGitHub <noreply@github.com>2017-07-14 09:48:01 +0200
commitdbbd5b4964615a63205fb9433f827f67265541de (patch)
tree1c1318a7532c91532ea1a369e3ae3a74ceaa7f63 /ucs2-interface/ucs-xml/UcsXml.h
parentfe0ce6f9892d29da52a4ed5024ebe9d5964c0171 (diff)
parent2d039f447c2b91ae5e41406238eea3950436c714 (diff)
Merge branch 'master' into UCS_Interface_Cleanup
Diffstat (limited to 'ucs2-interface/ucs-xml/UcsXml.h')
-rw-r--r--ucs2-interface/ucs-xml/UcsXml.h193
1 files changed, 100 insertions, 93 deletions
diff --git a/ucs2-interface/ucs-xml/UcsXml.h b/ucs2-interface/ucs-xml/UcsXml.h
index 883a9ff..2e5eef9 100644
--- a/ucs2-interface/ucs-xml/UcsXml.h
+++ b/ucs2-interface/ucs-xml/UcsXml.h
@@ -1,94 +1,101 @@
-/*
- * 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
-
+/*------------------------------------------------------------------------------------------------*/
+/* Unicens XML Parser */
+/* Copyright 2017, Microchip Technology Inc. and its subsidiaries. */
+/* */
+/* Redistribution and use in source and binary forms, with or without */
+/* modification, are permitted provided that the following conditions are met: */
+/* */
+/* 1. Redistributions of source code must retain the above copyright notice, this */
+/* list of conditions and the following disclaimer. */
+/* */
+/* 2. Redistributions in binary form must reproduce the above copyright notice, */
+/* this list of conditions and the following disclaimer in the documentation */
+/* and/or other materials provided with the distribution. */
+/* */
+/* 3. Neither the name of the copyright holder nor the names of its */
+/* contributors may be used to endorse or promote products derived from */
+/* this software without specific prior written permission. */
+/* */
+/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" */
+/* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
+/* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE */
+/* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE */
+/* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL */
+/* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR */
+/* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER */
+/* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, */
+/* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE */
+/* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+/*------------------------------------------------------------------------------------------------*/
+#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