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 */
26 #define I2C_MAX_DATA_SZ 32 /* max. number of bytes to be written to i2c */
27 #define CTRL_MAX_DATA_SZ 45 /* max. number of bytes to be written to control
30 #include <systemd/sd-event.h>
31 #include <sys/types.h>
42 #include "ucs_binding.h"
43 #include "ucs_interface.h"
45 #define MAX_FILENAME_LEN (100)
46 #define RX_BUFFER (64)
47 #define XML_CONFIG_FOLDER "/data/"
48 #define XML_CONFIG_FILE "config_multichannel_audio_kit.xml"
50 /** Internal structure, enabling multiple instances of this component.
51 * \note Do not access any of this variables.
56 char fileName[MAX_FILENAME_LEN];
57 uint8_t rxBuffer[RX_BUFFER];
66 UcsXmlVal_t* ucsConfig;
70 struct afb_event node_event;
74 static ucsContextT *ucsContextS = NULL;
75 static EventData_t *eventData = NULL;
77 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
78 /*AFB_DEBUG (afbIface, format, args); */
80 va_start (args, vargsCnt);
81 vfprintf (stderr, format, args);
86 va_start(argptr, vargsCnt);
87 vsprintf(outbuf, format, argptr);
89 AFB_WARNING ("%s", outbuf);
92 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
93 struct timespec currentTime;
97 if (clock_gettime(CLOCK_MONOTONIC_RAW, ¤tTime)) {
102 timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
106 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
107 ucsContextT *ucsContext = (ucsContextT*) pTag;
109 sd_event_source_unref(source);
110 UCSI_Timeout(&ucsContext->ucsiData);
115 void UCSI_CB_OnNetworkState(void *pTag, bool isAvailable, uint16_t packetBandwidth, uint8_t amountOfNodes)
117 AFB_NOTICE ("Network is available=%d, bw=%d, nodeCnt=%d", isAvailable, packetBandwidth, amountOfNodes);
120 /* UCS2 Interface Timer Callback */
121 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
123 /* set a timer with 250ms accuracy */
124 sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
125 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
130 * \brief Callback when ever an Unicens forms a human readable message.
131 * This can be error events or when enabled also debug messages.
132 * \note This function must be implemented by the integrator
133 * \param pTag - Pointer given by the integrator by UCSI_Init
134 * \param format - Zero terminated format string (following printf rules)
135 * \param vargsCnt - Amount of parameters stored in "..."
137 void UCSI_CB_OnUserMessage(void *pTag, bool isError, const char format[],
138 uint16_t vargsCnt, ...) {
142 va_start(argptr, vargsCnt);
143 vsprintf(outbuf, format, argptr);
145 AFB_NOTICE ("%s",outbuf);
148 /** UCSI_Service cannot be called directly within UNICENS context, need to service stack through mainloop */
149 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
150 ucsContextT *ucsContext = (ucsContextT*) pTag;
152 sd_event_source_unref(source);
153 UCSI_Service(&ucsContext->ucsiData);
157 /* UCS Callback fire when ever UNICENS needs to be serviced */
158 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
160 /* push an asynchronous request for loopback to call UCSI_Service */
161 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
164 /* Callback when ever this UNICENS wants to send a message to INIC. */
165 PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
166 ucsContextT *ucsContext = (ucsContextT*) pTag;
167 CdevData_t *cdevTx = &ucsContext->tx;
170 if (NULL == pData || 0 == len) return;
172 if (O_RDONLY == cdevTx->fileFlags) return;
173 if (-1 == cdevTx->fileHandle)
174 cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
175 if (-1 == cdevTx->fileHandle)
179 ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
182 /* Silently ignore write error (only occur in non-blocking mode) */
185 total += (uint32_t) written;
189 /** UcsXml_FreeVal be called directly within UNICENS context, need to service stack through mainloop */
190 STATIC int OnStopCB (sd_event_source *source, uint64_t usec, void *pTag) {
191 if (NULL != ucsContextS && NULL != ucsContextS->ucsConfig) {
192 UcsXml_FreeVal(ucsContextS->ucsConfig);
193 ucsContextS->ucsConfig = NULL;
199 * \brief Callback when UNICENS instance has been stopped.
200 * \note This event can be used to free memory holding the resources
201 * passed with UCSI_NewConfig
202 * \note This function must be implemented by the integrator
203 * \param pTag - Pointer given by the integrator by UCSI_Init
205 void UCSI_CB_OnStop(void *pTag) {
206 AFB_NOTICE ("UNICENS stopped");
207 /* push an asynchronous request for loopback to call UcsXml_FreeVal */
208 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, 0, 0, OnStopCB, pTag);
211 /** This callback will be raised, when ever an applicative message on the control channel arrived */
212 void UCSI_CB_OnAmsMessageReceived(void *pTag)
214 /* If not interested, just ignore this event.
215 Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content.
216 Don't forget to call UCSI_ReleaseAmsMessage after that */
219 void UCSI_CB_OnRouteResult(void *pTag, uint16_t routeId, bool isActive, uint16_t connectionLabel)
221 AFB_NOTICE ("Route 0x%X is active=%d, connection label=0x%X", routeId, isActive, connectionLabel);
224 void UCSI_CB_OnGpioStateChange(void *pTag, uint16_t nodeAddress, uint8_t gpioPinId, bool isHighState)
226 AFB_NOTICE ("GPIO state of node 0x%X changed, pin=%d isHigh=%d", nodeAddress, gpioPinId, isHighState);
229 PUBLIC void UCSI_CB_OnMgrReport(void *pTag, Ucs_MgrReport_t code, uint16_t nodeAddress, Ucs_Rm_Node_t *pNode){
233 if (code == UCS_MGR_REP_AVAILABLE) {
236 else if (code == UCS_MGR_REP_NOT_AVAILABLE) {
240 /*untracked event - just exit*/
246 json_object *j_event_info = json_object_new_object();
247 json_object_object_add(j_event_info, "node", json_object_new_int(nodeAddress));
248 json_object_object_add(j_event_info, "available", json_object_new_boolean(available));
250 afb_event_push(eventData->node_event, j_event_info);
254 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
256 if (NULL == d || NULL == fileName) goto OnErrorExit;
258 memset(d, 0, sizeof(CdevData_t));
259 strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
263 d->fileFlags = O_RDWR | O_NONBLOCK;
265 d->fileFlags = O_RDONLY | O_NONBLOCK;
267 d->fileFlags = O_WRONLY | O_NONBLOCK;
269 /* open file to enable event loop */
270 d->fileHandle = open(d->fileName, d->fileFlags);
271 if (d->fileHandle <= 0) goto OnErrorExit;
279 static bool InitializeCdevs(ucsContextT *ucsContext)
281 if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
283 if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
288 /* Callback fire when something is avaliable on MOST cdev */
289 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
290 ucsContextT *ucsContext =( ucsContextT*) pTag;
292 uint8_t pBuffer[RX_BUFFER];
295 len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
298 ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
300 AFB_DEBUG ("Buffer overrun (not handle)");
301 /* Buffer overrun could replay pBuffer */
307 STATIC char* GetDefaultConfig(void) {
309 char const *data_path = getenv("AFM_APP_INSTALL_DIR");
312 AFB_ERROR("AFM_APP_INSTALL_DIR is not defined");
318 AFB_NOTICE("AFM_APP_INSTALL_DIR is: %s", data_path);
319 size = strlen(data_path) + strlen(XML_CONFIG_FOLDER) + strlen(XML_CONFIG_FILE) + 2;
320 config_path = malloc(size);
321 if (config_path != NULL) {
322 snprintf(config_path, size, "%s%s%s", data_path, XML_CONFIG_FOLDER, XML_CONFIG_FILE);
323 if(access(config_path, R_OK ) == 0) {
324 AFB_NOTICE("Default configuration: %s", config_path);
333 STATIC UcsXmlVal_t* ParseFile(const char *filename) {
338 UcsXmlVal_t *ucsConfig = NULL;
340 fdHandle = open(filename, O_RDONLY);
342 AFB_ERROR("File not accessible: '%s' err=%s", filename, strerror(fdHandle));
346 /* read file into buffer as a \0 terminated string */
347 fstat(fdHandle, &fdStat);
348 xmlBuffer = (char*)alloca(fdStat.st_size + 1);
349 readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
351 xmlBuffer[readSize] = '\0'; /* In any case, terminate it. */
353 if (readSize != fdStat.st_size) {
354 AFB_ERROR("File to read fullfile '%s' size(%d!=%d)", filename, (int)readSize, (int)fdStat.st_size);
358 ucsConfig = UcsXml_Parse(xmlBuffer);
360 AFB_ERROR("File XML invalid: '%s'", filename);
363 AFB_NOTICE ("Parsing result: %d Nodes, %d Scripts, Ethernet Bandwith %d bytes = %.2f MBit/s", ucsConfig->nodSize, ucsConfig->routesSize, ucsConfig->packetBw, (48 * 8 * ucsConfig->packetBw / 1000.0));
371 PUBLIC int StartConfiguration(const char *filename) {
372 static ucsContextT ucsContext = { 0 };
374 sd_event_source *evtSource;
377 /* Read and parse XML file */
378 ucsContext.ucsConfig = ParseFile(filename);
379 if (NULL == ucsContext.ucsConfig) {
380 AFB_ERROR ("Cannot access or load file: '%s'", filename);
384 /* When ucsContextS is set, do not initalize UNICENS, CDEVs or system hooks, just load new XML */
387 if (!ucsContextS && !InitializeCdevs(&ucsContext)) {
388 AFB_ERROR ("Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
392 /* Initialise UNICENS Config Data Structure */
393 UCSI_Init(&ucsContext.ucsiData, &ucsContext);
395 /* register aplayHandle file fd into binder mainloop */
396 err = sd_event_add_io(afb_daemon_get_event_loop(), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
398 AFB_ERROR ("Cannot hook events to mainloop");
402 /* save this in a statical variable until ucs2vol move to C */
403 ucsContextS = &ucsContext;
405 /* Initialise UNICENS with parsed config */
406 if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsContext.ucsConfig)) {
407 AFB_ERROR ("Fail to initialize UNICENS");
417 PUBLIC void ucs2_initialise (struct afb_req request) {
418 const char *filename = afb_req_value(request, "filename");
421 afb_req_fail_f (request, "filename-missing", "No filename given");
425 if (StartConfiguration(filename) != 0) {
426 afb_req_fail_f (request, "load-failed", "Cannot parse file and start UNICENS");
430 afb_req_success(request,NULL,"UNICENS-active");
437 // List Avaliable Configuration Files
438 PUBLIC void ucs2_listconfig (struct afb_req request) {
439 struct json_object *queryJ, *tmpJ, *responseJ;
441 char *dirPath, *dirList;
444 queryJ = afb_req_json(request);
445 if (queryJ && json_object_object_get_ex (queryJ, "cfgpath" , &tmpJ)) {
446 dirList = strdup (json_object_get_string(tmpJ));
448 dirList = strdup (UCS2_CFG_PATH);
449 AFB_NOTICE ("fgpath:missing uses UCS2_CFG_PATH=%s", UCS2_CFG_PATH);
452 responseJ = json_object_new_array();
453 for (dirPath= strtok(dirList, ":"); dirPath && *dirPath; dirPath=strtok(NULL,":")) {
454 struct dirent *dirEnt;
456 dirHandle = opendir (dirPath);
458 AFB_NOTICE ("ucs2_listconfig dir=%s not readable", dirPath);
463 AFB_NOTICE ("ucs2_listconfig scanning: %s", dirPath);
464 while ((dirEnt = readdir(dirHandle)) != NULL) {
465 // Unknown type is accepted to support dump filesystems
466 if (dirEnt->d_type == DT_REG || dirEnt->d_type == DT_UNKNOWN) {
467 struct json_object *pathJ = json_object_new_object();
468 json_object_object_add(pathJ, "dirpath", json_object_new_string(dirPath));
469 json_object_object_add(pathJ, "basename", json_object_new_string(dirEnt->d_name));
470 json_object_array_add(responseJ, pathJ);
477 if (!error) afb_req_success(request,responseJ,NULL);
480 snprintf (info, sizeof(info), "[%d] where not scanned", error);
481 afb_req_success(request,responseJ, info);
487 PUBLIC void ucs2_subscribe (struct afb_req request) {
491 eventData = malloc(sizeof(EventData_t));
493 eventData->node_event = afb_daemon_make_event ("node-availibility");
496 if (!eventData || !afb_event_is_valid(eventData->node_event)) {
497 afb_req_fail_f (request, "create-event", "Cannot create or register event");
502 if (afb_req_subscribe(request, eventData->node_event) != 0) {
504 afb_req_fail_f (request, "subscribe-event", "Cannot subscribe to event");
508 afb_req_success(request,NULL,"event subscription successful");
514 static json_object * ucs2_validate_command (struct afb_req request,
515 const char* func_name) {
517 struct json_object *j_obj = NULL;
519 if (!ucsContextS) { /* check UNICENS is initialized */
520 afb_req_fail_f(request, "unicens-init",
521 "Load a configuration before calling %s.",
526 j_obj = afb_req_json(request);
528 afb_req_fail_f(request,
529 "query-notjson","query=%s not a valid json entry",
530 afb_req_value(request,""));
534 AFB_DEBUG("request: %s", json_object_to_json_string(j_obj));
536 if (json_object_get_type(j_obj)==json_type_array) {
537 int len = json_object_array_length(j_obj);
539 if (len == 1) { /* only support 1 command in array */
540 j_obj = json_object_array_get_idx(j_obj, 0);
543 afb_req_fail_f(request,
545 "query of multiple %s commands is not supported",
556 STATIC void ucs2_writei2c_CB (void *result_ptr, void *request_ptr) {
559 afb_req *req = (afb_req *)request_ptr;
560 Ucs_I2c_ResultCode_t *res = (Ucs_I2c_ResultCode_t *)result_ptr;
563 afb_req_fail(*req, "processing","busy or lost initialization");
565 else if (*res != UCS_I2C_RES_SUCCESS){
566 afb_req_fail_f(*req, "error-result", "result code: %d", *res);
569 afb_req_success(*req, NULL, "success");
576 AFB_NOTICE("write_i2c: ambiguous response data");
580 /* write a single i2c command */
581 STATIC void ucs2_writei2c_cmd(struct afb_req request, json_object *j_obj) {
583 static uint8_t i2c_data[I2C_MAX_DATA_SZ];
584 uint8_t i2c_data_sz = 0;
585 uint16_t node_addr = 0;
586 struct afb_req *async_req_ptr = NULL;
590 if (json_object_object_get_ex(j_obj, "node", &j_tmp)) {
591 node_addr = (uint16_t)json_object_get_int(j_tmp);
592 AFB_NOTICE("node_address: 0x%02X", node_addr);
593 if (node_addr == 0) {
594 afb_req_fail_f(request, "query-params","param node invalid type");
599 afb_req_fail_f(request, "query-params","param node missing");
603 key_found = json_object_object_get_ex(j_obj, "data", &j_tmp);
604 if (key_found && (json_object_get_type(j_tmp)==json_type_array)) {
605 int size = json_object_array_length(j_tmp);
606 if ((size > 0) && (size <= I2C_MAX_DATA_SZ)) {
610 struct json_object *j_elem;
612 for (i = 0; i < size; i++) {
614 j_elem = json_object_array_get_idx(j_tmp, i);
615 val = json_object_get_int(j_elem);
616 if ((val < 0) && (val > 0xFF)){
620 i2c_data[i] = (uint8_t)json_object_get_int(j_elem);
623 i2c_data_sz = (uint8_t)i;
627 if (i2c_data_sz == 0) {
628 AFB_NOTICE("data: invalid or not found");
629 afb_req_fail_f(request, "query-params","params wrong or missing");
633 async_req_ptr = malloc(sizeof(afb_req));
634 *async_req_ptr = request;
636 if (UCSI_I2CWrite( &ucsContextS->ucsiData, /* UCSI_Data_t *pPriv*/
637 node_addr, /* uint16_t targetAddress*/
638 false, /* bool isBurst*/
639 0u, /* block count */
640 0x2Au, /* i2c slave address */
641 0x03E8u, /* timeout 1000 milliseconds */
642 i2c_data_sz, /* uint8_t dataLen */
643 &i2c_data[0], /* uint8_t *pData */
644 &ucs2_writei2c_CB, /* callback*/
645 (void*)async_req_ptr /* callback argument */
647 /* asynchronous command is running */
648 afb_req_addref(request);
651 AFB_NOTICE("i2c write: scheduling command failed");
652 afb_req_fail_f(request, "query-command-queue","command queue overload");
654 async_req_ptr = NULL;
662 /* parse array or single command */
663 PUBLIC void ucs2_writei2c (struct afb_req request) {
665 struct json_object *j_obj;
667 j_obj = ucs2_validate_command(request, "writei2c");
670 ucs2_writei2c_cmd(request, j_obj);
674 /* write a single control message */
675 STATIC void ucs2_sendmessage_cmd(struct afb_req request, json_object *j_obj) {
677 static uint8_t ctrl_data[CTRL_MAX_DATA_SZ];
678 uint8_t ctrl_data_sz = 0;
679 uint16_t node_addr = 0;
683 if (json_object_object_get_ex(j_obj, "node", &j_tmp)) {
684 node_addr = (uint16_t)json_object_get_int(j_tmp);
685 AFB_NOTICE("node_address: 0x%02X", node_addr);
686 if (node_addr == 0) {
687 afb_req_fail_f(request, "query-params","param node invalid type");
692 afb_req_fail_f(request, "query-params","param node missing");
696 if (json_object_object_get_ex(j_obj, "msgid", &j_tmp)) {
697 if (json_object_get_type(j_tmp) == json_type_int) {
698 msg_id = (uint16_t)json_object_get_int(j_tmp);
699 AFB_NOTICE("msgid: 0x%02X", msg_id);
702 afb_req_fail_f(request, "query-params","param msgid invalid type");
707 afb_req_fail_f(request, "query-params","param msgid missing");
711 if (json_object_object_get_ex(j_obj, "data", &j_tmp)) {
712 if (json_object_get_type(j_tmp)==json_type_array) {
713 int size = json_object_array_length(j_tmp);
714 if ((size > 0) && (size <= CTRL_MAX_DATA_SZ)) {
717 struct json_object *j_elem;
719 for (i = 0; i < size; i++) {
720 j_elem = json_object_array_get_idx(j_tmp, i);
721 val = json_object_get_int(j_elem);
722 if ((val < 0) && (val > 0xFF)){
726 ctrl_data[i] = (uint8_t)json_object_get_int(j_elem);
729 if (i != size) { /* check if size matches */
730 afb_req_fail_f(request, "query-params",
731 "parameter data is ambiguous");
735 ctrl_data_sz = (uint8_t)i;
740 if (UCSI_SendAmsMessage(&ucsContextS->ucsiData, /* UCSI_Data_t *pPriv*/
745 afb_req_success(request, NULL, "sendmessage started successful");
748 AFB_NOTICE("sendmessage: scheduling command failed");
749 afb_req_fail_f(request, "query-command-queue","command queue overload");
757 PUBLIC void ucs2_sendmessage(struct afb_req request) {
758 struct json_object *j_obj;
760 j_obj = ucs2_validate_command(request, "sendmessage");
763 ucs2_sendmessage_cmd(request, j_obj);
767 PUBLIC int ucs2_initbinding(void) {
768 #ifndef DISABLE_AUTOSTART
769 char *filename = GetDefaultConfig();
770 if (filename != NULL) {
772 AFB_NOTICE("AUTO-LOAD configuration: %s", filename);
773 if (StartConfiguration(filename) == 0) {
774 AFB_NOTICE("AUTO-LOAD successful");
776 AFB_NOTICE("AUTO-LOAD failed");