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