SDS-Framework/ARM.SDS.pdsc at main · ARM-software/SDS-Framework · GitHub

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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?xml version="1.0" encoding="UTF-8"?>
<package schemaVersion="1.7.45" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="https://raw.githubusercontent.com/Open-CMSIS-Pack/Open-CMSIS-Pack-Spec/v1.7.45/schema/PACK.xsd">
  <vendor>ARM</vendor>
  <name>SDS</name>
  <description overview="overview/README.md">Synchronous Data Stream (SDS) Framework</description>
  <url>https://www.keil.com/pack/</url>
  <license>LICENSE</license>
  <licenseSets>
    <licenseSet id="all" default="true" gating="true">
      <license name="LICENSE" title="Apache 2.0 open-source license" spdx="Apache-2.0"/>
    </licenseSet>
  </licenseSets>
  <repository type="git">https://github.com/ARM-software/SDS-Framework.git</repository>

  <releases>
    <release version="2.2.0-dev">
      Active development ...
      SDSIO-Client:
      - Improved handling of initialization failure caused by ping timeout, preventing misleading "Ping received." SDSIO-Server message
      Template:
      - Fixed an issue in the simulator script (arm_vsi3.py) causing incomplete recorded data to be written to the file (missing data at the end)
    </release>
  </releases>

  <conditions>
    <condition id="SDS IO via VSI">
      <description>SDS IO via VSI</description>
      <require Cclass="CMSIS" Cgroup="RTOS2"/>
    </condition>
    <condition id="SDS IO via Socket">
      <description>SDS IO via Socket (IoT Socket)</description>
      <require Cclass="CMSIS"        Cgroup="RTOS2"/>
      <require Cclass="IoT Utility"  Cgroup="Socket"/>
    </condition>
    <condition id="SDS IO via USB - MDK USB">
      <description>SDS IO via USB (MDK USB)</description>
      <require Cclass="CMSIS" Cgroup="RTOS2"/>
      <require Cvendor="Keil" Cclass="USB" Cgroup="Device" Csub="Custom Class"/>
    </condition>
    <condition id="SDS IO via Serial Port - CMSIS USART">
      <description>SDS IO via Serial Port (CMSIS Driver USART)</description>
      <require Cclass="CMSIS"        Cgroup="RTOS2"/>
      <require Cclass="CMSIS Driver" Cgroup="USART"/>
    </condition>
    <condition id="SDS IO via File System - MDK FS">
      <description>SDS IO via File System (MDK FS)</description>
      <require Cvendor="Keil" Cclass="File System" Cgroup="Drive"/>
    </condition>
    <condition id="SDS IO via File System - Semihosting">
      <description>SDS IO via File System (Semihosting)</description>
      <require Cclass="CMSIS-View" Cgroup="Event Recorder" Cvariant="Semihosting"/>
    </condition>
    <condition id="SDS Recorder and Player with CMSIS-RTOS2">
      <description>SDS Recorder and Player with CMSIS-RTOS2</description>
      <require Cclass="CMSIS" Cgroup="RTOS2"/>
      <require Cclass="SDS"   Cgroup="Buffer"/>
      <require Cclass="SDS"   Cgroup="IO"/>
    </condition>
  </conditions>

  <taxonomy>
    <description Cclass="SDS" doc="docs/index.html">Synchronous Data Stream framework for developing DSP, ML, or Edge AI algorithms</description>
  </taxonomy>

  <apis>
    <api Cclass="SDS" Cgroup="IO" Capiversion="2.0.0">
      <description>Blocking I/O interface to read/write SDS files</description>
      <files>
        <file category="header" name="sds/include/sdsio.h" />
        <file category="doc"    name="docs/SDS_API/group__SDS__IO__Interface.html"/>
      </files>
    </api>
  </apis>

  <components>
    <!-- SDS -->
    <component Cclass="SDS" Cgroup="Buffer" Cversion="2.0.0">
      <description>Non-blocking read/write to a circular buffer</description>
      <RTE_Components_h>
        #define RTE_SDS_BUFFER                          /* Synchronous Data Stream Buffer */
      </RTE_Components_h>
      <files>
        <file category="header" name="sds/include/sds_buffer.h"/>
        <file category="source" name="sds/source/sds_buffer.c"/>
        <file category="header" name="sds/config/sds_buffer_config.h" attr="config" version="2.0.0"/>
        <file category="doc"    name="docs/SDS_API/group__SDS__Buffer.html"/>
      </files>
    </component>

    <!-- SDS I/O (VSI) -->
    <component Cclass="SDS" Cgroup="IO" Csub="VSI" Capiversion="2.0.0" Cversion="2.0.0" condition="SDS IO via VSI">
      <description>I/O via VSI</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_VSI                          /* Synchronous Data Stream Input/Output (VSI) */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/vsi/sdsio_vsi.c"/>
        <file category="doc"    name="docs/sdsio.html"/>
      </files>
    </component>

    <!-- SDS I/O (Socket) -->
    <component Cclass="SDS" Cgroup="IO" Csub="Socket" Capiversion="2.0.0" Cversion="2.0.1" condition="SDS IO via Socket">
      <description>I/O via Socket to SDSIO Server (using component MDK-Packs::IoT Utility:Socket)</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_SOCKET                       /* Synchronous Data Stream Input/Output (Socket) */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/client/sdsio_client.c"/>
        <file category="source" name="sds/source/sdsio/client/socket/sdsio_client_socket.c"/>
        <file category="header" name="sds/config/sdsio_config_socket.h" attr="config" version="2.0.0"/>
        <file category="doc"    name="docs/sdsio.html"/>
      </files>
    </component>

    <!-- SDS I/O (USB - MDK_USB) -->
    <component Cclass="SDS" Cgroup="IO" Csub="USB" Cvariant="MDK USB" Capiversion="2.0.0" Cversion="2.0.1" condition="SDS IO via USB - MDK USB">
      <description>I/O via USB Virtual COM Port to SDSIO Server (using component Keil::USB:Device:Custom)</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_USB                          /* Synchronous Data Stream Input/Output (USB) */
        #define RTE_SDS_IO_USB_MDK_USB                  /* Synchronous Data Stream Input/Output (USB - MDK USB) */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/client/sdsio_client.c"/>
        <file category="source" name="sds/source/sdsio/client/usb/mdk/sdsio_client_usb.c"/>
        <file category="header" name="sds/config/sdsio_config_usb_mdk.h" attr="config" version="2.0.0"/>
        <file category="doc"    name="docs/index.html"/>
      </files>
    </component>

    <!-- SDS I/O (Serial - CMSIS USART) -->
    <component Cclass="SDS" Cgroup="IO" Csub="Serial" Cvariant="CMSIS USART" Capiversion="2.0.0" Cversion="2.0.1" condition="SDS IO via Serial Port - CMSIS USART">
      <description>I/O via Serial Port to SDSIO Server (using component CMSIS Driver:USART)</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_SERIAL                       /* Synchronous Data Stream Input/Output (Serial) */
        #define RTE_SDS_IO_SERIAL_CMSIS_USART           /* Synchronous Data Stream Input/Output (Serial - CMSIS USART) */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/client/sdsio_client.c"/>
        <file category="source" name="sds/source/sdsio/client/serial/usart/sdsio_client_serial.c"/>
        <file category="header" name="sds/config/sdsio_config_serial_usart.h" attr="config" version="2.0.0"/>
        <file category="doc"    name="docs/sdsio.html"/>
      </files>
    </component>

    <!-- SDS I/O (Custom client) -->
    <component Cclass="SDS" Cgroup="IO" Csub="Custom" Capiversion="2.0.0" Cversion="2.0.1">
      <description>I/O via Custom I/O to SDSIO Server</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_CUSTOM                       /* Synchronous Data Stream Input/Output via Custom I/O */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/client/sdsio_client.c"/>
        <file category="source" name="sds/source/sdsio/client/template/sdsio_client_custom.c" attr="template" select="Custom SDS I/O Client Driver"/>
        <file category="doc"    name="docs/sdsio.html"/>
      </files>
    </component>

    <!-- SDS I/O (File System - MDK FS) -->
    <component Cclass="SDS" Cgroup="IO" Csub="File System" Cvariant="MDK FS" Capiversion="2.0.0" Cversion="2.0.0" condition="SDS IO via File System - MDK FS">
      <description>I/O via File System (using component Keil::File System)</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_FILE_SYSTEM                  /* Synchronous Data Stream Input/Output via File System */
        #define RTE_SDS_IO_FILE_SYSTEM_MDK_FS           /* Synchronous Data Stream Input/Output via File System (MDK FS) */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/fs/mdk/sdsio_fs.c"/>
        <file category="header" name="sds/config/sdsio_config_fs_mdk.h" attr="config" version="2.0.0"/>
        <file category="doc"    name="docs/sdsio.html"/>
      </files>
    </component>

    <!-- SDS I/O (File System - Semihosting) -->
    <component Cclass="SDS" Cgroup="IO" Csub="File System" Cvariant="Semihosting" Capiversion="2.0.0" Cversion="2.0.0" condition="SDS IO via File System - Semihosting">
      <description>I/O via File System (using Semihosting)</description>
      <RTE_Components_h>
        #define RTE_SDS_IO                              /* Synchronous Data Stream Input/Output */
        #define RTE_SDS_IO_FILE_SYSTEM                  /* Synchronous Data Stream Input/Output via File System */
        #define RTE_SDS_IO_FILE_SYSTEM_SEMIHOSTING      /* Synchronous Data Stream Input/Output via File System (Semihosting) */
      </RTE_Components_h>
      <files>
        <file category="source" name="sds/source/sdsio/fs/semihosting/sdsio_fs.c"/>
        <file category="doc"    name="docs/sdsio.html"/>
      </files>
    </component>

    <!-- SDS Recorder and Player -->
    <component Cclass="SDS" Cgroup="RecPlay" Cvariant="CMSIS-RTOS2" Cversion="2.0.0" condition="SDS Recorder and Player with CMSIS-RTOS2">
      <description>Recorder/Player interface for data stream</description>
      <RTE_Components_h>
        #define RTE_SDS_REC_PLAY                        /* Synchronous Data Stream Recorder and Player */
      </RTE_Components_h>
      <files>
        <file category="header" name="sds/include/sds_rec_play.h"/>
        <file category="source" name="sds/source/sds_rec_play.c"/>
        <file category="header" name="sds/config/sds_rec_play_config.h" attr="config" version="2.0.0"/>
        <file category="doc"    name="docs/SDS_API/group__SDS__Recorder__Player.html"/>
      </files>
    </component>
  </components>

  <csolution>
    <clayer type="SDSIO" path="layer/sdsio/usb"        file="sdsio_usb.clayer.yml"     copy-to="sdsio/usb"/>
    <clayer type="SDSIO" path="layer/sdsio/network"    file="sdsio_network.clayer.yml" copy-to="sdsio/network"/>
    <clayer type="SDSIO" path="layer/sdsio/filesystem" file="sdsio_fs.clayer.yml"      copy-to="sdsio/filesystem"/>
  </csolution>

  <examples>
    <example name="SDS" doc="README.md" folder="template">
      <description>Data streaming test framework for DSP/ML algorithm development</description>
      <project>
        <environment name="csolution" load="SDS.csolution.yml"/>
      </project>
    </example>
  </examples>
</package>