1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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_ */
|
