2 * Copyright (C) 2016 "IoT.bzh"
3 * Author Fulup Ar Foll <fulup@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 * https://gist.github.com/ghedo/963382
19 * http://alsa-utils.sourcearchive.com/documentation/1.0.15/aplay_8c-source.html
24 #define BUFFER_FRAME_COUNT 10 // max frames in buffer
25 #define WAIT_TIMER_US 1000000 // default waiting timer 1s
27 #include <systemd/sd-event.h>
28 #include <sys/types.h>
38 #include "ucs_binding.h"
39 #include "ucs_interface.h"
43 #define MAX_FILENAME_LEN (100)
44 #define RX_BUFFER (64)
46 /** Internal structure, enabling multiple instances of this component.
47 * \note Do not access any of this variables.
52 char fileName[MAX_FILENAME_LEN];
53 uint8_t rxBuffer[RX_BUFFER];
62 UCSI_channelsT *channels;
65 static ucsContextT *ucsContextS;
67 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
68 //DEBUG (afbIface, format, args);
70 va_start (args, vargsCnt);
71 vfprintf (stderr, format, args);
75 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
76 struct timespec currentTime;
80 if (clock_gettime(CLOCK_MONOTONIC_RAW, ¤tTime)) {
85 timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
89 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
90 ucsContextT *ucsContext = (ucsContextT*) pTag;
92 sd_event_source_unref(source);
93 UCSI_Timeout(&ucsContext->ucsiData);
98 // UCS2 Interface Timer Callback
99 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
101 // set a timer with 250ms accuracy
102 sd_event_now(afb_daemon_get_event_loop(afbIface->daemon), CLOCK_BOOTTIME, &usec);
103 sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
108 * \brief Callback when ever an Unicens forms a human readable message.
109 * This can be error events or when enabled also debug messages.
110 * \note This function must be implemented by the integrator
111 * \param pTag - Pointer given by the integrator by UCSI_Init
112 * \param format - Zero terminated format string (following printf rules)
113 * \param vargsCnt - Amount of parameters stored in "..."
115 void UCSI_CB_OnUserMessage(void *pTag, const char format[],
116 uint16_t vargsCnt, ...) {
117 //DEBUG (afbIface, format, args);
119 va_start (args, format);
120 vfprintf (stderr, format, args);
124 // UCSI_Service cannot be call directly within Unicens context, need to reset stack through mainloop
125 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
126 ucsContextT *ucsContext = (ucsContextT*) pTag;
128 sd_event_source_unref(source);
129 UCSI_Service(&ucsContext->ucsiData);
133 // UCS Callback fire when ever pTag instance needs to be serviced
134 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
136 // push an asynchronous request for loopback to call UCSI_Service
137 sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
142 * \brief Callback when ever a MOST error message was received.
143 * \note This function must be implemented by the integrator
144 * \param pTag - Pointer given by the integrator by UCSI_Init
145 * \note All following parameters belong to the usual MOST message
147 PUBLIC void UCSI_CB_OnMostError(void *pTag, uint16_t sourceAddr,
148 uint8_t fblock, uint8_t inst, uint16_t function, uint8_t op,
149 const uint8_t *pPayload, uint32_t payloadLen) {
151 // Error to send to syslog
152 DEBUG (afbIface, "OnMostError source=0x%x", sourceAddr);
157 // Callback when ever this instance wants to send a message to INIC.
158 // BUGS?? Sample was returning true/false on error when integration layer expect a void [question from Fulup to Thorsten]
159 PUBLIC void UCSI_CB_SendMostMessage(void *pTag, const uint8_t *pData, uint32_t len) {
161 ucsContextT *ucsContext = (ucsContextT*) pTag;
162 CdevData_t *cdevTx = &ucsContext->tx;
166 if (NULL == pData || 0 == len) return;
168 if (O_RDONLY == cdevTx->fileFlags) return;
169 if (-1 == cdevTx->fileHandle)
170 cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
171 if (-1 == cdevTx->fileHandle)
175 ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
178 cdevTx->fileHandle = -1;
181 total += (uint32_t) written;
188 * \brief Callback when Unicens instance has been stopped.
189 * \note This event can be used to free memory holding the resources
190 * passed with UCSI_NewConfig
191 * \note This function must be implemented by the integrator
192 * \param pTag - Pointer given by the integrator by UCSI_Init
194 void UCSI_CB_OnStop(void *pTag) {
195 NOTICE (afbIface, "Unicens stopped");
200 * \brief Callback on Unicens management results.
201 * \note This function must be implemented by the integrator
202 * \param pTag - Pointer given by the integrator by UCSI_Init
203 * \param code - Result code
204 * \param nodeAddress - Node address of the device causing this event
205 * \param pNode - Pointer to node structure holding details of changed node
207 extern void UCSI_CB_OnMgrReport(void *pTag, Ucs_MgrReport_t code, uint16_t nodeAddress, Ucs_Rm_Node_t *pNode) {
209 DEBUG (afbIface, "OnMgrReport: Ucs_MgrReport_t=%d nodeAdresse=0x%x", code, nodeAddress);
212 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
214 if (NULL == d || NULL == fileName) goto OnErrorExit;
216 memset(d, 0, sizeof(CdevData_t));
217 strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
221 d->fileFlags = O_RDWR | O_NONBLOCK;
223 d->fileFlags = O_RDONLY | O_NONBLOCK;
225 d->fileFlags = O_WRONLY | O_NONBLOCK;
227 // open file to enable event loop
228 d->fileHandle = open(d->fileName, d->fileFlags);
229 if (d->fileHandle <= 0) goto OnErrorExit;
237 static bool InitializeCdevs(ucsContextT *ucsContext)
239 if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
241 if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
246 // Callback fire when something is avaliable on MOST cdev
247 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
248 ucsContextT *ucsContext =( ucsContextT*) pTag;
250 uint8_t pBuffer[RX_BUFFER];
253 len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
255 ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
257 DEBUG (afbIface, "Buffer overrun (not handle)");
258 // Buffer overrun could replay pBuffer
263 STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
268 UcsXmlVal_t* ucsConfig;
270 const char *filename = afb_req_value(request, "filename");
272 afb_req_fail_f (request, "filename-missing", "No filename given");
276 fdHandle = open(filename, O_RDONLY);
278 afb_req_fail_f (request, "fileread-error", "File not accessible: '%s' err=%s", filename, strerror(fdHandle));
282 // read file into buffer as a \0 terminated string
283 fstat(fdHandle, &fdStat);
284 xmlBuffer = (char*)alloca(fdStat.st_size + 1);
285 readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
287 xmlBuffer[readSize] = '\0'; //In any case, terminate it.
289 if (readSize != fdStat.st_size) {
290 afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, readSize, fdStat.st_size);
294 ucsConfig = UcsXml_Parse(xmlBuffer);
296 afb_req_fail_f (request, "filexml-error", "File XML invalid: '%s'", filename);
306 STATIC int volOnSvcCB (sd_event_source* source,uint64_t timer, void* pTag) {
307 ucsContextT *ucsContext = (ucsContextT*) pTag;
309 sd_event_source_unref(source);
310 UCSI_Vol_Service(&ucsContext->ucsiData);
315 // This callback is fire each time an volume event wait in the queue
316 void volumeCB (uint16_t timeout) {
318 sd_event_now(afb_daemon_get_event_loop(afbIface->daemon), CLOCK_BOOTTIME, &usec);
319 sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
322 STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsContextT *ucsContext) {
324 struct json_object *nameJ, *channelJ, *volJ;
326 enum json_type jtype= json_object_get_type(commandJ);
328 case json_type_array:
329 if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 0)), "%d", &numid)) {
330 afb_req_fail_f (request, "channel-invalid","command=%s channel is not an integer", json_object_get_string (channelJ));
333 if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 1)), "%d", &vol)) {
334 afb_req_fail_f (request, "vol-invalid","command=%s vol is not an integer", json_object_get_string (channelJ));
339 case json_type_object:
340 if (json_object_object_get_ex (commandJ, "numid", &channelJ)) {
341 if (!sscanf (json_object_get_string (channelJ), "%d", &numid)) {
342 afb_req_fail_f (request, "channel-invalid","command=%s numid is not an integer", json_object_get_string (channelJ));
346 if (json_object_object_get_ex (commandJ, "channel", &nameJ)) {
348 const char *name = json_object_get_string(nameJ);
350 for (idx =0; ucsContext->channels[idx].name != NULL; idx++) {
351 if (!strcasecmp(ucsContext->channels[idx].name, name)) {
352 numid = ucsContext->channels[idx].numid;
356 if (ucsContext->channels[idx].name == NULL) {
357 afb_req_fail_f (request, "channel-invalid","command=%s channel name does not exist", name);
361 afb_req_fail_f (request, "channel-invalid","command=%s no valid channel name or channel", json_object_get_string(commandJ));
366 if (!json_object_object_get_ex (commandJ, "volume", &volJ)) {
367 afb_req_fail_f (request, "vol-missing","command=%s vol not present", json_object_get_string (commandJ));
371 if (!sscanf (json_object_get_string (volJ), "%d", &vol)) {
372 afb_req_fail_f (request, "vol-invalid","command=%s vol:%s is not an integer", json_object_get_string (commandJ), json_object_get_string (volJ));
379 afb_req_fail_f (request, "setvol-invalid","command=%s not valid JSON Volume Command", json_object_get_string(commandJ));
384 // Fulup what's append when channel or vol are invalid ???
385 err = UCSI_Vol_Set (&ucsContext->ucsiData, numid, (uint8_t) vol);
387 // Fulup this might only be a warning (not sure about it)
388 afb_req_fail_f (request, "vol-refused","command=%s vol was refused by UNICENS", json_object_get_string (volJ));
399 PUBLIC void ucs2SetVol (struct afb_req request) {
400 struct json_object *queryJ;
403 // check UNICENS is initialised
405 afb_req_fail_f (request, "UNICENS-init","Should Load Config before using setvol");
409 queryJ = afb_req_json(request);
411 afb_req_fail_f (request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
415 enum json_type jtype= json_object_get_type(queryJ);
417 case json_type_array:
418 for (int idx=0; idx < json_object_array_length (queryJ); idx ++) {
419 err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS);
420 if (err) goto OnErrorExit;
424 case json_type_object:
425 err = volSndCmd (request, queryJ, ucsContextS);
426 if (err) goto OnErrorExit;
430 afb_req_fail_f (request, "query-notarray","query=%s not valid JSON Volume Command Array", afb_req_value(request,""));
435 afb_req_success(request,NULL,NULL);
442 PUBLIC void ucs2Init (struct afb_req request) {
443 static UcsXmlVal_t *ucsConfig;
444 static ucsContextT ucsContext;
446 sd_event_source *evtSource;
449 // Read and parse XML file
450 ucsConfig = ParseFile (request);
451 if (NULL == ucsConfig) goto OnErrorExit;
453 // Fulup->Thorsten BUG InitializeCdevs should fail when control does not exit
454 if (!InitializeCdevs(&ucsContext)) {
455 afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
459 // Initialise Unicens Config Data Structure
460 UCSI_Init(&ucsContext.ucsiData, &ucsContext);
462 // Initialise Unicens with parsed config
463 if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig)) {
464 afb_req_fail_f (request, "UNICENS-init", "Fail to initialize Unicens");
468 // register aplayHandle file fd into binder mainloop
469 err = sd_event_add_io(afb_daemon_get_event_loop(afbIface->daemon), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
471 afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
475 // init Unicens Volume Library
476 ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
477 if (!ucsContext.channels) {
478 afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
481 // save this in a statical variable until ucs2vol move to C
482 ucsContextS = &ucsContext;
484 afb_req_success(request,NULL,"UNICENS-active");