Implement handling of GPIO, I2C, Routes
[apps/agl-service-unicens.git] / ucs2-afb / ucs_binding.c
1 /*
2  * Copyright (C) 2016 "IoT.bzh"
3  * Author Fulup Ar Foll <fulup@iot.bzh>
4  *
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
8  *
9  *   http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  *
17  * references:
18  *   https://gist.github.com/ghedo/963382
19  *   http://alsa-utils.sourcearchive.com/documentation/1.0.15/aplay_8c-source.html
20  */
21
22 #define _GNU_SOURCE
23
24 #define BUFFER_FRAME_COUNT 10 /* max frames in buffer */
25 #define WAIT_TIMER_US 1000000 /* default waiting timer 1s */
26
27 #include <systemd/sd-event.h>
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <stdio.h>
31 #include <fcntl.h>
32 #include <string.h>
33 #include <unistd.h>
34 #include <time.h>
35 #include <assert.h>
36 #include <errno.h>
37
38 #include "ucs_binding.h"
39 #include "ucs_interface.h"
40
41
42
43 #define MAX_FILENAME_LEN (100)
44 #define RX_BUFFER (64)
45
46 /** Internal structure, enabling multiple instances of this component.
47  * \note Do not access any of this variables.
48  *  */
49 typedef struct {
50     int fileHandle;
51     int fileFlags;
52     char fileName[MAX_FILENAME_LEN];
53     uint8_t rxBuffer[RX_BUFFER];
54     uint32_t rxLen;
55 } CdevData_t;
56
57
58 typedef struct {
59   CdevData_t rx;
60   CdevData_t tx;
61   UCSI_Data_t ucsiData;
62   UCSI_channelsT *channels;
63 } ucsContextT;
64
65 static ucsContextT *ucsContextS;
66
67 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
68     /*DEBUG (afbIface, format, args); */
69     va_list args;
70     va_start (args, vargsCnt);
71     vfprintf (stderr, format, args);
72     va_end(args);
73 }
74
75 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
76     struct timespec currentTime;
77     uint16_t timer;
78     pTag = pTag;
79
80     if (clock_gettime(CLOCK_MONOTONIC_RAW, &currentTime))   {
81         assert(false);
82         return 0;
83     }
84
85     timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
86     return(timer);
87 }
88
89 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
90     ucsContextT *ucsContext = (ucsContextT*) pTag;
91
92     sd_event_source_unref(source);
93     UCSI_Timeout(&ucsContext->ucsiData);
94
95     return 0;
96 }
97
98 /* UCS2 Interface Timer Callback */
99 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
100   uint64_t usec;
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);
104
105 }
106
107 /**
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 "..."
114  */
115 void UCSI_CB_OnUserMessage(void *pTag, bool isError, const char format[],
116     uint16_t vargsCnt, ...) {
117     va_list argptr;
118     char outbuf[300];
119     pTag = pTag;
120     va_start(argptr, vargsCnt);
121     vsprintf(outbuf, format, argptr);
122     va_end(argptr);
123     if (isError)
124         NOTICE (afbIface, outbuf);
125 }
126
127 /** UCSI_Service cannot be called directly within UNICENS context, need to service stack through mainloop */
128 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
129     ucsContextT *ucsContext = (ucsContextT*) pTag;
130
131     sd_event_source_unref(source);
132     UCSI_Service(&ucsContext->ucsiData);
133     return (0);
134 }
135
136 /* UCS Callback fire when ever UNICENS needs to be serviced */
137 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
138
139    /* push an asynchronous request for loopback to call UCSI_Service */
140    sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
141 }
142
143 /* Callback when ever this UNICENS wants to send a message to INIC. */
144 PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
145     ucsContextT *ucsContext = (ucsContextT*) pTag;
146     CdevData_t *cdevTx = &ucsContext->tx;
147     uint32_t total = 0;
148
149     if (NULL == pData || 0 == len) return;
150
151     if (O_RDONLY == cdevTx->fileFlags) return;
152     if (-1 == cdevTx->fileHandle)
153         cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
154     if (-1 == cdevTx->fileHandle)
155         return;
156
157     while(total < len) {
158         ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
159         if (0 >= written)
160         {
161             /* Silently ignore write error (only occur in non-blocking mode) */
162             break;
163         }
164         total += (uint32_t) written;
165     }
166 }
167
168 /**
169  * \brief Callback when UNICENS instance has been stopped.
170  * \note This event can be used to free memory holding the resources
171  *       passed with UCSI_NewConfig
172  * \note This function must be implemented by the integrator
173  * \param pTag - Pointer given by the integrator by UCSI_Init
174  */
175 void UCSI_CB_OnStop(void *pTag) {
176     NOTICE (afbIface, "UNICENS stopped");
177
178 }
179
180 /** This callback will be raised, when ever an applicative message on the control channel arrived */
181 void UCSI_CB_OnAmsMessageReceived(void *pTag)
182 {
183         /* If not interested, just ignore this event.
184            Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content. 
185            Don't forget to call UCSI_ReleaseAmsMessage after that */
186 }
187
188 void UCSI_CB_OnRouteResult(void *pTag, uint16_t routeId, bool isActive)
189 {
190 }
191
192 void UCSI_CB_OnGpioStateChange(void *pTag, uint16_t nodeAddress, uint8_t gpioPinId, bool isHighState)
193 {
194 }
195
196 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
197 {
198     if (NULL == d || NULL == fileName)  goto OnErrorExit;
199
200     memset(d, 0, sizeof(CdevData_t));
201     strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
202     d->fileHandle = -1;
203
204     if (read && write)
205         d->fileFlags = O_RDWR | O_NONBLOCK;
206     else if (read)
207         d->fileFlags = O_RDONLY | O_NONBLOCK;
208     else if (write)
209         d->fileFlags = O_WRONLY | O_NONBLOCK;
210
211     /* open file to enable event loop */
212     d->fileHandle = open(d->fileName, d->fileFlags);
213     if (d->fileHandle  <= 0) goto OnErrorExit;
214
215     return true;
216
217  OnErrorExit:
218     return false;
219 }
220
221 static bool InitializeCdevs(ucsContextT *ucsContext)
222 {
223     if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
224         return false;
225     if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
226         return false;
227     return true;
228 }
229
230 /* Callback fire when something is avaliable on MOST cdev */
231 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
232     ucsContextT *ucsContext =( ucsContextT*) pTag;
233     ssize_t len;
234     uint8_t pBuffer[RX_BUFFER];
235     int ok;
236
237     len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
238     if (0 == len)
239         return 0;
240     ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
241     if (!ok) {
242         DEBUG (afbIface, "Buffer overrun (not handle)");
243         /* Buffer overrun could replay pBuffer */
244     }
245     return 0;
246 }
247
248 STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
249     char *xmlBuffer;
250     ssize_t readSize;
251     int fdHandle ;
252     struct stat fdStat;
253     UcsXmlVal_t* ucsConfig;
254
255     const char *filename = afb_req_value(request, "filename");
256     if (!filename) {
257         afb_req_fail_f (request, "filename-missing", "No filename given");
258         goto OnErrorExit;
259     }
260
261     fdHandle = open(filename, O_RDONLY);
262     if (fdHandle <= 0) {
263         afb_req_fail_f (request, "fileread-error", "File not accessible: '%s' err=%s", filename, strerror(fdHandle));
264         goto OnErrorExit;
265     }
266
267     /* read file into buffer as a \0 terminated string */
268     fstat(fdHandle, &fdStat);
269     xmlBuffer = (char*)alloca(fdStat.st_size + 1);
270     readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
271     close(fdHandle);
272     xmlBuffer[readSize] = '\0'; /* In any case, terminate it. */
273
274     if (readSize != fdStat.st_size)  {
275         afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, readSize, fdStat.st_size);
276         goto OnErrorExit;
277     }
278
279     ucsConfig = UcsXml_Parse(xmlBuffer);
280     if (!ucsConfig)  {
281         afb_req_fail_f (request, "filexml-error", "File XML invalid: '%s'", filename);
282         goto OnErrorExit;
283     }
284
285     return (ucsConfig);
286
287  OnErrorExit:
288     return NULL;
289 }
290
291 STATIC int volOnSvcCB (sd_event_source* source,uint64_t timer, void* pTag) {
292     ucsContextT *ucsContext = (ucsContextT*) pTag;
293
294     sd_event_source_unref(source);
295     UCSI_Vol_Service(&ucsContext->ucsiData);
296
297     return 0;
298 }
299
300 /* This callback is fire each time an volume event wait in the queue */
301 void volumeCB (uint16_t timeout) {
302     uint64_t usec;
303     sd_event_now(afb_daemon_get_event_loop(afbIface->daemon), CLOCK_BOOTTIME, &usec);
304     sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
305 }
306
307 STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsContextT *ucsContext) {
308     int numid, vol, err;
309     struct json_object *nameJ, *channelJ, *volJ;
310
311     enum json_type jtype= json_object_get_type(commandJ);
312     switch (jtype) {
313         case json_type_array:
314             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 0)), "%d", &numid)) {
315                 afb_req_fail_f (request, "channel-invalid","command=%s channel is not an integer", json_object_get_string (channelJ));
316                 goto OnErrorExit;
317             }
318             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 1)), "%d", &vol)) {
319                 afb_req_fail_f (request, "vol-invalid","command=%s vol is not an integer", json_object_get_string (channelJ));
320                 goto OnErrorExit;
321             }
322             break;
323
324         case json_type_object:
325             if (json_object_object_get_ex (commandJ, "numid", &channelJ)) {
326                 if (!sscanf (json_object_get_string (channelJ), "%d", &numid)) {
327                     afb_req_fail_f (request, "channel-invalid","command=%s numid is not an integer", json_object_get_string (channelJ));
328                     goto OnErrorExit;
329                 }
330             } else {
331                 if (json_object_object_get_ex (commandJ, "channel", &nameJ)) {
332                     int idx;
333                     const char *name = json_object_get_string(nameJ);
334
335                     for (idx =0; ucsContext->channels[idx].name != NULL; idx++) {
336                         if (!strcasecmp(ucsContext->channels[idx].name, name)) {
337                             numid = ucsContext->channels[idx].numid;
338                             break;
339                         }
340                     }
341                     if (ucsContext->channels[idx].name == NULL) {
342                         afb_req_fail_f (request, "channel-invalid","command=%s channel name does not exist", name);
343                         goto OnErrorExit;
344                     }
345                 } else {
346                     afb_req_fail_f (request, "channel-invalid","command=%s no valid channel name or channel", json_object_get_string(commandJ));
347                     goto OnErrorExit;
348                 };
349             }
350
351             if (!json_object_object_get_ex (commandJ, "volume", &volJ)) {
352                 afb_req_fail_f (request, "vol-missing","command=%s vol not present", json_object_get_string (commandJ));
353                 goto OnErrorExit;
354             }
355
356             if (!sscanf (json_object_get_string (volJ), "%d", &vol)) {
357                 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));
358                 goto OnErrorExit;
359             }
360
361             break;
362
363         default:
364             afb_req_fail_f (request, "setvol-invalid","command=%s not valid JSON Volume Command", json_object_get_string(commandJ));
365             goto OnErrorExit;
366     }
367
368
369     /* Fulup what's append when channel or vol are invalid ??? */
370     err = UCSI_Vol_Set  (&ucsContext->ucsiData, numid, (uint8_t) vol);
371     if (err) {
372         /* Fulup this might only be a warning (not sure about it) */
373         afb_req_fail_f (request, "vol-refused","command=%s vol was refused by UNICENS", json_object_get_string (volJ));
374         goto OnErrorExit;
375     }
376
377     return 0;
378
379   OnErrorExit:
380     return 1;
381 }
382
383
384 PUBLIC void ucs2SetVol (struct afb_req request) {
385     struct json_object *queryJ;
386     int err;
387
388     /* check UNICENS is initialised */
389     if (!ucsContextS) {
390         afb_req_fail_f (request, "UNICENS-init","Should Load Config before using setvol");
391         goto OnErrorExit;
392     }
393
394     queryJ = afb_req_json(request);
395     if (!queryJ) {
396         afb_req_fail_f (request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
397         goto OnErrorExit;
398     };
399
400     enum json_type jtype= json_object_get_type(queryJ);
401     switch (jtype) {
402         case json_type_array:
403             for (int idx=0; idx < json_object_array_length (queryJ); idx ++) {
404                err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS);
405                if (err) goto OnErrorExit;
406             }
407             break;
408
409         case json_type_object:
410             err = volSndCmd (request, queryJ, ucsContextS);
411             if (err) goto OnErrorExit;
412             break;
413
414         default:
415             afb_req_fail_f (request, "query-notarray","query=%s not valid JSON Volume Command Array", afb_req_value(request,""));
416             goto OnErrorExit;
417     }
418
419
420     afb_req_success(request,NULL,NULL);
421
422  OnErrorExit:
423     return;
424 }
425
426
427 PUBLIC void ucs2Init (struct afb_req request) {
428     static UcsXmlVal_t *ucsConfig;
429     static ucsContextT ucsContext;
430
431     sd_event_source *evtSource;
432     int err;
433
434     /* Read and parse XML file */
435     ucsConfig = ParseFile (request);
436     if (NULL == ucsConfig) goto OnErrorExit;
437
438     /* When ucsContextS is set, do not initalize UNICENS, CDEVs or system hooks, just load new XML */
439     if (!ucsContextS)
440     {
441         if (!ucsContextS && !InitializeCdevs(&ucsContext))  {
442             afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
443             goto OnErrorExit;
444         }
445
446         /* Initialise UNICENS Config Data Structure */
447         UCSI_Init(&ucsContext.ucsiData, &ucsContext);
448
449         /* register aplayHandle file fd into binder mainloop */
450         err = sd_event_add_io(afb_daemon_get_event_loop(afbIface->daemon), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
451         if (err < 0) {
452             afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
453             goto OnErrorExit;
454         }
455
456         /* init UNICENS Volume Library */
457         ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
458         if (!ucsContext.channels) {
459             afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
460             goto OnErrorExit;
461         }
462         /* save this in a statical variable until ucs2vol move to C */
463         ucsContextS = &ucsContext;
464     }
465     /* Initialise UNICENS with parsed config */
466     if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig))   {
467         afb_req_fail_f (request, "UNICENS-init", "Fail to initialize UNICENS");
468         goto OnErrorExit;
469     }
470
471     afb_req_success(request,NULL,"UNICENS-active");
472
473  OnErrorExit:
474     return;
475 }