Initial API-V2 ajusted HTML page to fit new commands names
[apps/agl-service-unicens.git] / ucs2-afb / ucs_binding.c
index 9be4a1b..efb4928 100644 (file)
@@ -13,7 +13,7 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- * 
+ *
  * references:
  *   https://gist.github.com/ghedo/963382
  *   http://alsa-utils.sourcearchive.com/documentation/1.0.15/aplay_8c-source.html
@@ -21,8 +21,8 @@
 
 #define _GNU_SOURCE
 
-#define BUFFER_FRAME_COUNT 10 // max frames in buffer
-#define WAIT_TIMER_US 1000000 // default waiting timer 1s
+#define BUFFER_FRAME_COUNT 10 /* max frames in buffer */
+#define WAIT_TIMER_US 1000000 /* default waiting timer 1s */
 
 #include <systemd/sd-event.h>
 #include <sys/types.h>
@@ -65,43 +65,50 @@ typedef struct {
 static ucsContextT *ucsContextS;
 
 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
-    //DEBUG (afbIface, format, args);
+    /*AFB_DEBUG (afbIface, format, args); */
     va_list args;
-    va_start (args, format);
+    va_start (args, vargsCnt);
     vfprintf (stderr, format, args);
     va_end(args);
+    
+    va_list argptr;
+    char outbuf[300];
+    va_start(argptr, vargsCnt);
+    vsprintf(outbuf, format, argptr);
+    va_end(argptr);
+    AFB_WARNING (outbuf);
 }
 
 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
     struct timespec currentTime;
     uint16_t timer;
     pTag = pTag;
-    
+
     if (clock_gettime(CLOCK_MONOTONIC_RAW, &currentTime))   {
         assert(false);
         return 0;
     }
-    
+
     timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
-    return(timer);        
+    return(timer);
 }
 
 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
     ucsContextT *ucsContext = (ucsContextT*) pTag;
 
-    sd_event_source_unref(source);    
+    sd_event_source_unref(source);
     UCSI_Timeout(&ucsContext->ucsiData);
 
     return 0;
 }
 
-// UCS2 Interface Timer Callback
+/* UCS2 Interface Timer Callback */
 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
   uint64_t usec;
-  // set a timer with  250ms accuracy 
-  sd_event_now(afb_daemon_get_event_loop(afbIface->daemon), CLOCK_BOOTTIME, &usec);  
-  sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
-    
+  /* set a timer with  250ms accuracy */
+  sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
+  sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
+
 }
 
 /**
@@ -112,124 +119,100 @@ PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
  * \param format - Zero terminated format string (following printf rules)
  * \param vargsCnt - Amount of parameters stored in "..."
  */
-void UCSI_CB_OnUserMessage(void *pTag, const char format[],
+void UCSI_CB_OnUserMessage(void *pTag, bool isError, const char format[],
     uint16_t vargsCnt, ...) {
-    //DEBUG (afbIface, format, args);
-    va_list args;
-    va_start (args, format);
-    vfprintf (stderr, format, args);
-    va_end(args);
+    va_list argptr;
+    char outbuf[300];
+    pTag = pTag;
+    va_start(argptr, vargsCnt);
+    vsprintf(outbuf, format, argptr);
+    va_end(argptr);
+    if (isError)
+        AFB_NOTICE (outbuf);
 }
 
-// UCSI_Service cannot be call directly within Unicens context, need to reset stack through mainloop
+/** UCSI_Service cannot be called directly within UNICENS context, need to service stack through mainloop */
 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
     ucsContextT *ucsContext = (ucsContextT*) pTag;
-    
+
     sd_event_source_unref(source);
     UCSI_Service(&ucsContext->ucsiData);
     return (0);
 }
 
-// UCS Callback fire when ever pTag instance needs to be serviced
+/* UCS Callback fire when ever UNICENS needs to be serviced */
 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
-    
-   // push an asynchronous request for loopback to call UCSI_Service
-   sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
-}
-
 
-/**
- * \brief Callback when ever a MOST error message was received.
- * \note This function must be implemented by the integrator
- * \param pTag - Pointer given by the integrator by UCSI_Init
- * \note All following parameters belong to the usual MOST message
- */
-PUBLIC void UCSI_CB_OnMostError(void *pTag, uint16_t sourceAddr,
-    uint8_t fblock, uint8_t inst, uint16_t function, uint8_t op,
-    const uint8_t *pPayload, uint32_t payloadLen) {
-    
-    // Error to send to syslog
-    DEBUG (afbIface, "OnMostError source=0x%x", sourceAddr);
+   /* push an asynchronous request for loopback to call UCSI_Service */
+   sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
 }
 
-
-
-// Callback when ever this instance wants to send a message to INIC.
-// BUGS?? Sample was returning true/false on error when integration layer expect a void [question from Fulup to Thorsten]
-PUBLIC void UCSI_CB_SendMostMessage(void *pTag, const uint8_t *pData, uint32_t len) {
-    
+/* Callback when ever this UNICENS wants to send a message to INIC. */
+PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
     ucsContextT *ucsContext = (ucsContextT*) pTag;
     CdevData_t *cdevTx = &ucsContext->tx;
     uint32_t total = 0;
-    
-    
+
     if (NULL == pData || 0 == len) return;
-    
+
     if (O_RDONLY == cdevTx->fileFlags) return;
     if (-1 == cdevTx->fileHandle)
         cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
     if (-1 == cdevTx->fileHandle)
         return;
-    
+
     while(total < len) {
         ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
         if (0 >= written)
         {
-            cdevTx->fileHandle = -1;
-            return;
+            /* Silently ignore write error (only occur in non-blocking mode) */
+            break;
         }
         total += (uint32_t) written;
     }
-    
-    return;    
 }
 
 /**
- * \brief Callback when Unicens instance has been stopped.
+ * \brief Callback when UNICENS instance has been stopped.
  * \note This event can be used to free memory holding the resources
  *       passed with UCSI_NewConfig
  * \note This function must be implemented by the integrator
  * \param pTag - Pointer given by the integrator by UCSI_Init
  */
 void UCSI_CB_OnStop(void *pTag) {
-    NOTICE (afbIface, "Unicens stopped");
-    
+    AFB_NOTICE ("UNICENS stopped");
+
 }
 
-/**
- * \brief Callback on Unicens management results.
- * \note This function must be implemented by the integrator
- * \param pTag - Pointer given by the integrator by UCSI_Init
- * \param code - Result code
- * \param nodeAddress - Node address of the device causing this event
- * \param pNode - Pointer to node structure holding details of changed node
- */
-extern void UCSI_CB_OnMgrReport(void *pTag, Ucs_MgrReport_t code, uint16_t nodeAddress, Ucs_Rm_Node_t *pNode) {
-    
-    DEBUG (afbIface, "OnMgrReport: Ucs_MgrReport_t=%d nodeAdresse=0x%x", code, nodeAddress);
+/** This callback will be raised, when ever an applicative message on the control channel arrived */
+void UCSI_CB_OnAmsMessageReceived(void *pTag)
+{
+       /* If not interested, just ignore this event.
+          Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content. 
+          Don't forget to call UCSI_ReleaseAmsMessage after that */
 }
 
 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
 {
     if (NULL == d || NULL == fileName)  goto OnErrorExit;
-    
+
     memset(d, 0, sizeof(CdevData_t));
     strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
     d->fileHandle = -1;
-    
+
     if (read && write)
         d->fileFlags = O_RDWR | O_NONBLOCK;
     else if (read)
         d->fileFlags = O_RDONLY | O_NONBLOCK;
     else if (write)
         d->fileFlags = O_WRONLY | O_NONBLOCK;
-   
-    // open file to enable event loop
-    d->fileHandle = open(d->fileName, d->fileFlags);    
+
+    /* open file to enable event loop */
+    d->fileHandle = open(d->fileName, d->fileFlags);
     if (d->fileHandle  <= 0) goto OnErrorExit;
-    
+
     return true;
-    
+
  OnErrorExit:
     return false;
 }
@@ -243,7 +226,7 @@ static bool InitializeCdevs(ucsContextT *ucsContext)
     return true;
 }
 
-// Callback fire when something is avaliable on MOST cdev
+/* Callback fire when something is avaliable on MOST cdev */
 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
     ucsContextT *ucsContext =( ucsContextT*) pTag;
     ssize_t len;
@@ -251,13 +234,14 @@ int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
     int ok;
 
     len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
-    
+    if (0 == len)
+        return 0;
     ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
     if (!ok) {
-        DEBUG (afbIface, "Buffer overrun (not handle)");
-        // Buffer overrun could replay pBuffer
+        AFB_DEBUG ("Buffer overrun (not handle)");
+        /* Buffer overrun could replay pBuffer */
     }
-    return(0);
+    return 0;
 }
 
 STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
@@ -265,40 +249,40 @@ STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
     ssize_t readSize;
     int fdHandle ;
     struct stat fdStat;
-    UcsXmlVal_t* ucsConfig; 
+    UcsXmlVal_t* ucsConfig;
 
     const char *filename = afb_req_value(request, "filename");
     if (!filename) {
         afb_req_fail_f (request, "filename-missing", "No filename given");
-        goto OnErrorExit;            
+        goto OnErrorExit;
     }
-    
+
     fdHandle = open(filename, O_RDONLY);
     if (fdHandle <= 0) {
         afb_req_fail_f (request, "fileread-error", "File not accessible: '%s' err=%s", filename, strerror(fdHandle));
         goto OnErrorExit;
     }
-    
-    // read file into buffer as a \0 terminated string
+
+    /* read file into buffer as a \0 terminated string */
     fstat(fdHandle, &fdStat);
     xmlBuffer = (char*)alloca(fdStat.st_size + 1);
     readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
     close(fdHandle);
-    xmlBuffer[readSize] = '\0'; //In any case, terminate it.
-    
+    xmlBuffer[readSize] = '\0'; /* In any case, terminate it. */
+
     if (readSize != fdStat.st_size)  {
-        afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, readSize, fdStat.st_size);
+        afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, (int)readSize, (int)fdStat.st_size);
         goto OnErrorExit;
     }
-   
+
     ucsConfig = UcsXml_Parse(xmlBuffer);
     if (!ucsConfig)  {
         afb_req_fail_f (request, "filexml-error", "File XML invalid: '%s'", filename);
         goto OnErrorExit;
     }
-    
+
     return (ucsConfig);
-    
+
  OnErrorExit:
     return NULL;
 }
@@ -312,11 +296,11 @@ STATIC int volOnSvcCB (sd_event_source* source,uint64_t timer, void* pTag) {
     return 0;
 }
 
-// This callback is fire each time an volume event wait in the queue
+/* This callback is fire each time an volume event wait in the queue */
 void volumeCB (uint16_t timeout) {
     uint64_t usec;
-    sd_event_now(afb_daemon_get_event_loop(afbIface->daemon), CLOCK_BOOTTIME, &usec);
-    sd_event_add_time(afb_daemon_get_event_loop(afbIface->daemon), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
+    sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
+    sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
 }
 
 STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsContextT *ucsContext) {
@@ -328,21 +312,21 @@ STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsC
         case json_type_array:
             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 0)), "%d", &numid)) {
                 afb_req_fail_f (request, "channel-invalid","command=%s channel is not an integer", json_object_get_string (channelJ));
-                goto OnErrorExit;                        
-            }            
+                goto OnErrorExit;
+            }
             if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 1)), "%d", &vol)) {
                 afb_req_fail_f (request, "vol-invalid","command=%s vol is not an integer", json_object_get_string (channelJ));
-                goto OnErrorExit;                        
-            }            
+                goto OnErrorExit;
+            }
             break;
-            
-        case json_type_object:  
+
+        case json_type_object:
             if (json_object_object_get_ex (commandJ, "numid", &channelJ)) {
                 if (!sscanf (json_object_get_string (channelJ), "%d", &numid)) {
                     afb_req_fail_f (request, "channel-invalid","command=%s numid is not an integer", json_object_get_string (channelJ));
-                    goto OnErrorExit;                        
-                }            
-            } else {    
+                    goto OnErrorExit;
+                }
+            } else {
                 if (json_object_object_get_ex (commandJ, "channel", &nameJ)) {
                     int idx;
                     const char *name = json_object_get_string(nameJ);
@@ -355,134 +339,141 @@ STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsC
                     }
                     if (ucsContext->channels[idx].name == NULL) {
                         afb_req_fail_f (request, "channel-invalid","command=%s channel name does not exist", name);
-                        goto OnErrorExit;            
-                    }            
+                        goto OnErrorExit;
+                    }
                 } else {
                     afb_req_fail_f (request, "channel-invalid","command=%s no valid channel name or channel", json_object_get_string(commandJ));
-                    goto OnErrorExit;            
+                    goto OnErrorExit;
                 };
             }
-            
+
             if (!json_object_object_get_ex (commandJ, "volume", &volJ)) {
                 afb_req_fail_f (request, "vol-missing","command=%s vol not present", json_object_get_string (commandJ));
-                goto OnErrorExit;                        
+                goto OnErrorExit;
             }
-    
+
             if (!sscanf (json_object_get_string (volJ), "%d", &vol)) {
                 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));
-                goto OnErrorExit;                        
+                goto OnErrorExit;
             }
 
             break;
-            
-        default:           
+
+        default:
             afb_req_fail_f (request, "setvol-invalid","command=%s not valid JSON Volume Command", json_object_get_string(commandJ));
-            goto OnErrorExit; 
+            goto OnErrorExit;
     }
-    
-    
-    // Fulup what's append when channel or vol are invalid ???
+
+
+    /* Fulup what's append when channel or vol are invalid ??? */
     err = UCSI_Vol_Set  (&ucsContext->ucsiData, numid, (uint8_t) vol);
     if (err) {
-        // Fulup this might only be a warning (not sure about it)
-        afb_req_fail_f (request, "vol-refused","command=%s vol was refused by unicens", json_object_get_string (volJ));
-        goto OnErrorExit; 
+        /* Fulup this might only be a warning (not sure about it) */
+        afb_req_fail_f (request, "vol-refused","command=%s vol was refused by UNICENS", json_object_get_string (volJ));
+        goto OnErrorExit;
     }
-    
+
     return 0;
-    
-  OnErrorExit: 
+
+  OnErrorExit:
     return 1;
 }
-    
 
-PUBLIC void ucs2SetVol (struct afb_req request) {
+
+PUBLIC void ucs2_volume (struct afb_req request) {
     struct json_object *queryJ;
     int err;
-    
-    // check unicens is initialised
+
+    /* check UNICENS is initialised */
     if (!ucsContextS) {
-        afb_req_fail_f (request, "unicens-init","Should Load Config before using setvol");
-        goto OnErrorExit;                
+        afb_req_fail_f (request, "UNICENS-init","Should Load Config before using setvol");
+        goto OnErrorExit;
     }
-    
+
     queryJ = afb_req_json(request);
     if (!queryJ) {
         afb_req_fail_f (request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
-        goto OnErrorExit;        
+        goto OnErrorExit;
     };
-    
+
     enum json_type jtype= json_object_get_type(queryJ);
     switch (jtype) {
         case json_type_array:
             for (int idx=0; idx < json_object_array_length (queryJ); idx ++) {
-               err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS); 
+               err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS);
                if (err) goto OnErrorExit;
             }
             break;
-            
+
         case json_type_object:
             err = volSndCmd (request, queryJ, ucsContextS);
             if (err) goto OnErrorExit;
             break;
-        
-        default:           
+
+        default:
             afb_req_fail_f (request, "query-notarray","query=%s not valid JSON Volume Command Array", afb_req_value(request,""));
-            goto OnErrorExit;        
+            goto OnErrorExit;
     }
-    
 
-    afb_req_success(request,NULL,NULL); 
-    
+
+    afb_req_success(request,NULL,NULL);
+
  OnErrorExit:
     return;
 }
 
 
-PUBLIC void ucs2Init (struct afb_req request) {
+PUBLIC void ucs2_configure (struct afb_req request) {
     static UcsXmlVal_t *ucsConfig;
     static ucsContextT ucsContext;
 
     sd_event_source *evtSource;
     int err;
-    
-    // Read and parse XML file
+
+    /* Read and parse XML file */
     ucsConfig = ParseFile (request);
     if (NULL == ucsConfig) goto OnErrorExit;
-    
-    // Fulup->Thorsten BUG InitializeCdevs should fail when control does not exit
-    if (!InitializeCdevs(&ucsContext))  {
-        afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
-        goto OnErrorExit;
-    }
 
-    // Initialise Unicens Config Data Structure
-    UCSI_Init(&ucsContext.ucsiData, &ucsContext);
-    
-    // Initialise Unicens with parsed config
-    if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig))   {
-        afb_req_fail_f (request, "unicens-init", "Fail to initialize Unicens");
-        goto OnErrorExit;
-    }
+    /* When ucsContextS is set, do not initalize UNICENS, CDEVs or system hooks, just load new XML */
+    if (!ucsContextS)
+    {
+        if (!ucsContextS && !InitializeCdevs(&ucsContext))  {
+            afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
+            goto OnErrorExit;
+        }
 
-    // register aplayHandle file fd into binder mainloop
-    err = sd_event_add_io(afb_daemon_get_event_loop(afbIface->daemon), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
-    if (err < 0) {
-        afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
-        goto OnErrorExit;
+        /* Initialise UNICENS Config Data Structure */
+        UCSI_Init(&ucsContext.ucsiData, &ucsContext);
+
+        /* register aplayHandle file fd into binder mainloop */
+        err = sd_event_add_io(afb_daemon_get_event_loop(), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
+        if (err < 0) {
+            afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
+            goto OnErrorExit;
+        }
+
+        /* init UNICENS Volume Library */
+        ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
+        if (!ucsContext.channels) {
+            afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
+            goto OnErrorExit;
+        }
+        /* save this in a statical variable until ucs2vol move to C */
+        ucsContextS = &ucsContext;
     }
-    
-    // init Unicens Volume Library
-    ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
-    if (!ucsContext.channels) {
-        afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
+    /* Initialise UNICENS with parsed config */
+    if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig))   {
+        afb_req_fail_f (request, "UNICENS-init", "Fail to initialize UNICENS");
         goto OnErrorExit;
     }
-    // save this in a statical variable until ucs2vol move to C
-    ucsContextS = &ucsContext;
-            
-    afb_req_success(request,NULL,"unicens-active"); 
-    
+
+    afb_req_success(request,NULL,"UNICENS-active");
+
  OnErrorExit:
     return;
 }
+
+PUBLIC void ucs2_monitor (struct afb_req request) {
+    
+   afb_req_success(request,NULL,"UNICENS-to_be_done"); 
+}
\ No newline at end of file