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, format);
  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 call directly within Unicens context, need to reset 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 pTag instance 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 instance wants to send a message to INIC.
 144 // BUGS?? Sample was returning true/false on error when integration layer expect a void [question from Fulup to Thorsten]
 145 PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
 146
 147     ucsContextT *ucsContext = (ucsContextT*) pTag;
 148     CdevData_t *cdevTx = &ucsContext->tx;
 149     uint32_t total = 0;
 150
 151
 152     if (NULL == pData || 0 == len) return;
 153
 154     if (O_RDONLY == cdevTx->fileFlags) return;
 155     if (-1 == cdevTx->fileHandle)
 156         cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
 157     if (-1 == cdevTx->fileHandle)
 158         return;
 159
 160     while(total < len) {
 161         ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
 162         if (0 >= written)
 163         {
 164             cdevTx->fileHandle = -1;
 165             return;
 166         }
 167         total += (uint32_t) written;
 168     }
 169
 170     return;
 171 }
 172
 173 /**
 174  * \brief Callback when Unicens instance has been stopped.
 175  * \note This event can be used to free memory holding the resources
 176  *       passed with UCSI_NewConfig
 177  * \note This function must be implemented by the integrator
 178  * \param pTag - Pointer given by the integrator by UCSI_Init
 179  */
 180 void UCSI_CB_OnStop(void *pTag) {
 181     NOTICE (afbIface, "Unicens stopped");
 182
 183 }
 184
 185 /** This callback will be raised, when ever an applicative message on the control channel arrived */
 186 void UCSI_CB_OnAmsMessageReceived(void *pTag)
 187 {
 188         /* If not interested, just ignore this event.
 189            Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content.
 190            Don't forget to call UCSI_ReleaseAmsMessage after that */
 191 }
 192
 193 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
 194 {
 195     if (NULL == d || NULL == fileName)  goto OnErrorExit;
 196
 197     memset(d, 0, sizeof(CdevData_t));
 198     strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
 199     d->fileHandle = -1;
 200
 201     if (read && write)
 202         d->fileFlags = O_RDWR | O_NONBLOCK;
 203     else if (read)
 204         d->fileFlags = O_RDONLY | O_NONBLOCK;
 205     else if (write)
 206         d->fileFlags = O_WRONLY | O_NONBLOCK;
 207
 208     // open file to enable event loop
 209     d->fileHandle = open(d->fileName, d->fileFlags);
 210     if (d->fileHandle  <= 0) goto OnErrorExit;
 211
 212     return true;
 213
 214  OnErrorExit:
 215     return false;
 216 }
 217
 218 static bool InitializeCdevs(ucsContextT *ucsContext)
 219 {
 220     if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
 221         return false;
 222     if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
 223         return false;
 224     return true;
 225 }
 226
 227 // Callback fire when something is avaliable on MOST cdev
 228 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
 229     ucsContextT *ucsContext =( ucsContextT*) pTag;
 230     ssize_t len;
 231     uint8_t pBuffer[RX_BUFFER];
 232     int ok;
 233
 234     len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
 235     if (0 == len)
 236         return 0;
 237     ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
 238     if (!ok) {
 239         DEBUG (afbIface, "Buffer overrun (not handle)");
 240         // Buffer overrun could replay pBuffer
 241     }
 242     return(0);
 243 }
 244
 245 STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
 246     char *xmlBuffer;
 247     ssize_t readSize;
 248     int fdHandle ;
 249     struct stat fdStat;
 250     UcsXmlVal_t* ucsConfig;
 251
 252     const char *filename = afb_req_value(request, "filename");
 253     if (!filename) {
 254         afb_req_fail_f (request, "filename-missing", "No filename given");
 255         goto OnErrorExit;
 256     }
 257
 258     fdHandle = open(filename, O_RDONLY);
 259     if (fdHandle <= 0) {
 260         afb_req_fail_f (request, "fileread-error", "File not accessible: '%s' err=%s", filename, strerror(fdHandle));
 261         goto OnErrorExit;
 262     }
 263
 264     // read file into buffer as a \0 terminated string
 265     fstat(fdHandle, &fdStat);
 266     xmlBuffer = (char*)alloca(fdStat.st_size + 1);
 267     readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
 268     close(fdHandle);
 269     xmlBuffer[readSize] = '\0'; //In any case, terminate it.
 270
 271     if (readSize != fdStat.st_size)  {
 272         afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, readSize, fdStat.st_size);
 273         goto OnErrorExit;
 274     }
 275
 276     ucsConfig = UcsXml_Parse(xmlBuffer);
 277     if (!ucsConfig)  {
 278         afb_req_fail_f (request, "filexml-error", "File XML invalid: '%s'", filename);
 279         goto OnErrorExit;
 280     }
 281
 282     return (ucsConfig);
 283
 284  OnErrorExit:
 285     return NULL;
 286 }
 287
 288 STATIC int volOnSvcCB (sd_event_source* source,uint64_t timer, void* pTag) {
 289     ucsContextT *ucsContext = (ucsContextT*) pTag;
 290
 291     sd_event_source_unref(source);
 292     UCSI_Vol_Service(&ucsContext->ucsiData);
 293
 294     return 0;
 295 }
 296
 297 // This callback is fire each time an volume event wait in the queue
 298 void volumeCB (uint16_t timeout) {
 299     uint64_t usec;
 300     sd_event_now(afb_daemon_get_event_loop(afbIface->daemon), CLOCK_BOOTTIME, &usec);
 301     sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
 302 }
 303
 304 STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsContextT *ucsContext) {
 305     int numid, vol, err;
 306     struct json_object *nameJ, *channelJ, *volJ;
 307
 308     enum json_type jtype= json_object_get_type(commandJ);
 309     switch (jtype) {
 310         case json_type_array:
 311             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 0)), "%d", &numid)) {
 312                 afb_req_fail_f (request, "channel-invalid","command=%s channel is not an integer", json_object_get_string (channelJ));
 313                 goto OnErrorExit;
 314             }
 315             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 1)), "%d", &vol)) {
 316                 afb_req_fail_f (request, "vol-invalid","command=%s vol is not an integer", json_object_get_string (channelJ));
 317                 goto OnErrorExit;
 318             }
 319             break;
 320
 321         case json_type_object:
 322             if (json_object_object_get_ex (commandJ, "numid", &channelJ)) {
 323                 if (!sscanf (json_object_get_string (channelJ), "%d", &numid)) {
 324                     afb_req_fail_f (request, "channel-invalid","command=%s numid is not an integer", json_object_get_string (channelJ));
 325                     goto OnErrorExit;
 326                 }
 327             } else {
 328                 if (json_object_object_get_ex (commandJ, "channel", &nameJ)) {
 329                     int idx;
 330                     const char *name = json_object_get_string(nameJ);
 331
 332                     for (idx =0; ucsContext->channels[idx].name != NULL; idx++) {
 333                         if (!strcasecmp(ucsContext->channels[idx].name, name)) {
 334                             numid = ucsContext->channels[idx].numid;
 335                             break;
 336                         }
 337                     }
 338                     if (ucsContext->channels[idx].name == NULL) {
 339                         afb_req_fail_f (request, "channel-invalid","command=%s channel name does not exist", name);
 340                         goto OnErrorExit;
 341                     }
 342                 } else {
 343                     afb_req_fail_f (request, "channel-invalid","command=%s no valid channel name or channel", json_object_get_string(commandJ));
 344                     goto OnErrorExit;
 345                 };
 346             }
 347
 348             if (!json_object_object_get_ex (commandJ, "volume", &volJ)) {
 349                 afb_req_fail_f (request, "vol-missing","command=%s vol not present", json_object_get_string (commandJ));
 350                 goto OnErrorExit;
 351             }
 352
 353             if (!sscanf (json_object_get_string (volJ), "%d", &vol)) {
 354                 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));
 355                 goto OnErrorExit;
 356             }
 357
 358             break;
 359
 360         default:
 361             afb_req_fail_f (request, "setvol-invalid","command=%s not valid JSON Volume Command", json_object_get_string(commandJ));
 362             goto OnErrorExit;
 363     }
 364
 365
 366     // Fulup what's append when channel or vol are invalid ???
 367     err = UCSI_Vol_Set  (&ucsContext->ucsiData, numid, (uint8_t) vol);
 368     if (err) {
 369         // Fulup this might only be a warning (not sure about it)
 370         afb_req_fail_f (request, "vol-refused","command=%s vol was refused by UNICENS", json_object_get_string (volJ));
 371         goto OnErrorExit;
 372     }
 373
 374     return 0;
 375
 376   OnErrorExit:
 377     return 1;
 378 }
 379
 380
 381 PUBLIC void ucs2SetVol (struct afb_req request) {
 382     struct json_object *queryJ;
 383     int err;
 384
 385     // check UNICENS is initialised
 386     if (!ucsContextS) {
 387         afb_req_fail_f (request, "UNICENS-init","Should Load Config before using setvol");
 388         goto OnErrorExit;
 389     }
 390
 391     queryJ = afb_req_json(request);
 392     if (!queryJ) {
 393         afb_req_fail_f (request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
 394         goto OnErrorExit;
 395     };
 396
 397     enum json_type jtype= json_object_get_type(queryJ);
 398     switch (jtype) {
 399         case json_type_array:
 400             for (int idx=0; idx < json_object_array_length (queryJ); idx ++) {
 401                err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS);
 402                if (err) goto OnErrorExit;
 403             }
 404             break;
 405
 406         case json_type_object:
 407             err = volSndCmd (request, queryJ, ucsContextS);
 408             if (err) goto OnErrorExit;
 409             break;
 410
 411         default:
 412             afb_req_fail_f (request, "query-notarray","query=%s not valid JSON Volume Command Array", afb_req_value(request,""));
 413             goto OnErrorExit;
 414     }
 415
 416
 417     afb_req_success(request,NULL,NULL);
 418
 419  OnErrorExit:
 420     return;
 421 }
 422
 423
 424 PUBLIC void ucs2Init (struct afb_req request) {
 425     static UcsXmlVal_t *ucsConfig;
 426     static ucsContextT ucsContext;
 427
 428     sd_event_source *evtSource;
 429     int err;
 430
 431     // Read and parse XML file
 432     ucsConfig = ParseFile (request);
 433     if (NULL == ucsConfig) goto OnErrorExit;
 434
 435     // Fulup->Thorsten BUG InitializeCdevs should fail when control does not exit
 436     if (!InitializeCdevs(&ucsContext))  {
 437         afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
 438         goto OnErrorExit;
 439     }
 440
 441     // Initialise Unicens Config Data Structure
 442     UCSI_Init(&ucsContext.ucsiData, &ucsContext);
 443
 444     // Initialise Unicens with parsed config
 445     if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig))   {
 446         afb_req_fail_f (request, "UNICENS-init", "Fail to initialize Unicens");
 447         goto OnErrorExit;
 448     }
 449
 450     // register aplayHandle file fd into binder mainloop
 451     err = sd_event_add_io(afb_daemon_get_event_loop(afbIface->daemon), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
 452     if (err < 0) {
 453         afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
 454         goto OnErrorExit;
 455     }
 456
 457     // init Unicens Volume Library
 458     ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
 459     if (!ucsContext.channels) {
 460         afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
 461         goto OnErrorExit;
 462     }
 463     // save this in a statical variable until ucs2vol move to C
 464     ucsContextS = &ucsContext;
 465
 466     afb_req_success(request,NULL,"UNICENS-active");
 467
 468  OnErrorExit:
 469     return;
 470 }