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 */
28 #include <systemd/sd-event.h>
29 #include <sys/types.h>
40 #include "ucs_binding.h"
41 #include "ucs_interface.h"
43 #define MAX_FILENAME_LEN (100)
44 #define RX_BUFFER (64)
45 #define XML_CONFIG_FOLDER "/data/"
46 #define XML_CONFIG_FILE "config_multichannel_audio_kit.xml"
48 /** Internal structure, enabling multiple instances of this component.
49 * \note Do not access any of this variables.
54 char fileName[MAX_FILENAME_LEN];
55 uint8_t rxBuffer[RX_BUFFER];
67 struct afb_event node_event;
71 static ucsContextT *ucsContextS;
72 static EventData_t *eventData = NULL;
74 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
75 /*AFB_DEBUG (afbIface, format, args); */
77 va_start (args, vargsCnt);
78 vfprintf (stderr, format, args);
83 va_start(argptr, vargsCnt);
84 vsprintf(outbuf, format, argptr);
86 AFB_WARNING ("%s", outbuf);
89 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
90 struct timespec currentTime;
94 if (clock_gettime(CLOCK_MONOTONIC_RAW, ¤tTime)) {
99 timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
103 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
104 ucsContextT *ucsContext = (ucsContextT*) pTag;
106 sd_event_source_unref(source);
107 UCSI_Timeout(&ucsContext->ucsiData);
112 void UCSI_CB_OnNetworkState(void *pTag, bool isAvailable, uint16_t packetBandwidth, uint8_t amountOfNodes)
116 /* UCS2 Interface Timer Callback */
117 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
119 /* set a timer with 250ms accuracy */
120 sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
121 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
126 * \brief Callback when ever an Unicens forms a human readable message.
127 * This can be error events or when enabled also debug messages.
128 * \note This function must be implemented by the integrator
129 * \param pTag - Pointer given by the integrator by UCSI_Init
130 * \param format - Zero terminated format string (following printf rules)
131 * \param vargsCnt - Amount of parameters stored in "..."
133 void UCSI_CB_OnUserMessage(void *pTag, bool isError, const char format[],
134 uint16_t vargsCnt, ...) {
138 va_start(argptr, vargsCnt);
139 vsprintf(outbuf, format, argptr);
142 AFB_NOTICE ("%s",outbuf);
145 /** UCSI_Service cannot be called directly within UNICENS context, need to service stack through mainloop */
146 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
147 ucsContextT *ucsContext = (ucsContextT*) pTag;
149 sd_event_source_unref(source);
150 UCSI_Service(&ucsContext->ucsiData);
154 /* UCS Callback fire when ever UNICENS needs to be serviced */
155 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
157 /* push an asynchronous request for loopback to call UCSI_Service */
158 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
161 /* Callback when ever this UNICENS wants to send a message to INIC. */
162 PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
163 ucsContextT *ucsContext = (ucsContextT*) pTag;
164 CdevData_t *cdevTx = &ucsContext->tx;
167 if (NULL == pData || 0 == len) return;
169 if (O_RDONLY == cdevTx->fileFlags) return;
170 if (-1 == cdevTx->fileHandle)
171 cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
172 if (-1 == cdevTx->fileHandle)
176 ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
179 /* Silently ignore write error (only occur in non-blocking mode) */
182 total += (uint32_t) written;
187 * \brief Callback when UNICENS instance has been stopped.
188 * \note This event can be used to free memory holding the resources
189 * passed with UCSI_NewConfig
190 * \note This function must be implemented by the integrator
191 * \param pTag - Pointer given by the integrator by UCSI_Init
193 void UCSI_CB_OnStop(void *pTag) {
194 AFB_NOTICE ("UNICENS stopped");
198 /** This callback will be raised, when ever an applicative message on the control channel arrived */
199 void UCSI_CB_OnAmsMessageReceived(void *pTag)
201 /* If not interested, just ignore this event.
202 Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content.
203 Don't forget to call UCSI_ReleaseAmsMessage after that */
206 void UCSI_CB_OnRouteResult(void *pTag, uint16_t routeId, bool isActive, uint16_t connectionLabel)
210 void UCSI_CB_OnGpioStateChange(void *pTag, uint16_t nodeAddress, uint8_t gpioPinId, bool isHighState)
214 PUBLIC void UCSI_CB_OnMgrReport(void *pTag, Ucs_MgrReport_t code, uint16_t nodeAddress, Ucs_Rm_Node_t *pNode){
218 if (code == UCS_MGR_REP_AVAILABLE) {
221 else if (code == UCS_MGR_REP_NOT_AVAILABLE) {
225 /*untracked event - just exit*/
231 json_object *j_event_info = json_object_new_object();
232 json_object_object_add(j_event_info, "node", json_object_new_int(nodeAddress));
233 json_object_object_add(j_event_info, "available", json_object_new_boolean(available));
235 afb_event_push(eventData->node_event, j_event_info);
239 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
241 if (NULL == d || NULL == fileName) goto OnErrorExit;
243 memset(d, 0, sizeof(CdevData_t));
244 strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
248 d->fileFlags = O_RDWR | O_NONBLOCK;
250 d->fileFlags = O_RDONLY | O_NONBLOCK;
252 d->fileFlags = O_WRONLY | O_NONBLOCK;
254 /* open file to enable event loop */
255 d->fileHandle = open(d->fileName, d->fileFlags);
256 if (d->fileHandle <= 0) goto OnErrorExit;
264 static bool InitializeCdevs(ucsContextT *ucsContext)
266 if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
268 if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
273 /* Callback fire when something is avaliable on MOST cdev */
274 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
275 ucsContextT *ucsContext =( ucsContextT*) pTag;
277 uint8_t pBuffer[RX_BUFFER];
280 len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
283 ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
285 AFB_DEBUG ("Buffer overrun (not handle)");
286 /* Buffer overrun could replay pBuffer */
292 STATIC char* GetDefaultConfig(void) {
294 char const *data_path = getenv("AFM_APP_INSTALL_DIR");
297 AFB_ERROR("AFM_APP_INSTALL_DIR is not defined");
303 AFB_NOTICE("AFM_APP_INSTALL_DIR is: %s", data_path);
304 size = strlen(data_path) + strlen(XML_CONFIG_FOLDER) + strlen(XML_CONFIG_FILE) + 2;
305 config_path = malloc(size);
306 if (config_path != NULL) {
307 snprintf(config_path, size, "%s%s%s", data_path, XML_CONFIG_FOLDER, XML_CONFIG_FILE);
308 if(access(config_path, R_OK ) == 0) {
309 AFB_NOTICE("Default configuration: %s", config_path);
318 STATIC UcsXmlVal_t* ParseFile(const char *filename) {
323 UcsXmlVal_t* ucsConfig;
325 fdHandle = open(filename, O_RDONLY);
327 AFB_ERROR("File not accessible: '%s' err=%s", filename, strerror(fdHandle));
331 /* read file into buffer as a \0 terminated string */
332 fstat(fdHandle, &fdStat);
333 xmlBuffer = (char*)alloca(fdStat.st_size + 1);
334 readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
336 xmlBuffer[readSize] = '\0'; /* In any case, terminate it. */
338 if (readSize != fdStat.st_size) {
339 AFB_ERROR("File to read fullfile '%s' size(%d!=%d)", filename, (int)readSize, (int)fdStat.st_size);
343 ucsConfig = UcsXml_Parse(xmlBuffer);
345 AFB_ERROR("File XML invalid: '%s'", filename);
355 PUBLIC int StartConfiguration(const char *filename) {
356 static UcsXmlVal_t *ucsConfig;
357 static ucsContextT ucsContext;
359 sd_event_source *evtSource;
362 /* Read and parse XML file */
363 ucsConfig = ParseFile(filename);
364 if (NULL == ucsConfig) {
365 AFB_ERROR ("Cannot access or load file: '%s'", filename);
369 /* When ucsContextS is set, do not initalize UNICENS, CDEVs or system hooks, just load new XML */
372 if (!ucsContextS && !InitializeCdevs(&ucsContext)) {
373 AFB_ERROR ("Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
377 /* Initialise UNICENS Config Data Structure */
378 UCSI_Init(&ucsContext.ucsiData, &ucsContext);
380 /* register aplayHandle file fd into binder mainloop */
381 err = sd_event_add_io(afb_daemon_get_event_loop(), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
383 AFB_ERROR ("Cannot hook events to mainloop");
387 /* save this in a statical variable until ucs2vol move to C */
388 ucsContextS = &ucsContext;
390 /* Initialise UNICENS with parsed config */
391 if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig)) {
392 AFB_ERROR ("Fail to initialize UNICENS");
402 PUBLIC void ucs2_initialise (struct afb_req request) {
403 const char *filename = afb_req_value(request, "filename");
406 afb_req_fail_f (request, "filename-missing", "No filename given");
410 if (StartConfiguration(filename) != 0) {
411 afb_req_fail_f (request, "load-failed", "Cannot parse file and start UNICENS");
415 afb_req_success(request,NULL,"UNICENS-active");
422 // List Avaliable Configuration Files
423 PUBLIC void ucs2_listconfig (struct afb_req request) {
424 struct json_object *queryJ, *tmpJ, *responseJ;
426 char *dirPath, *dirList;
429 queryJ = afb_req_json(request);
430 if (queryJ && json_object_object_get_ex (queryJ, "cfgpath" , &tmpJ)) {
431 dirList = strdup (json_object_get_string(tmpJ));
433 dirList = strdup (UCS2_CFG_PATH);
434 AFB_NOTICE ("fgpath:missing uses UCS2_CFG_PATH=%s", UCS2_CFG_PATH);
437 responseJ = json_object_new_array();
438 for (dirPath= strtok(dirList, ":"); dirPath && *dirPath; dirPath=strtok(NULL,":")) {
439 struct dirent *dirEnt;
441 dirHandle = opendir (dirPath);
443 AFB_NOTICE ("ucs2_listconfig dir=%s not readable", dirPath);
448 AFB_NOTICE ("ucs2_listconfig scanning: %s", dirPath);
449 while ((dirEnt = readdir(dirHandle)) != NULL) {
450 // Unknown type is accepted to support dump filesystems
451 if (dirEnt->d_type == DT_REG || dirEnt->d_type == DT_UNKNOWN) {
452 struct json_object *pathJ = json_object_new_object();
453 json_object_object_add(pathJ, "dirpath", json_object_new_string(dirPath));
454 json_object_object_add(pathJ, "basename", json_object_new_string(dirEnt->d_name));
455 json_object_array_add(responseJ, pathJ);
462 if (!error) afb_req_success(request,responseJ,NULL);
465 snprintf (info, sizeof(info), "[%d] where not scanned", error);
466 afb_req_success(request,responseJ, info);
472 PUBLIC void ucs2_subscribe (struct afb_req request) {
476 eventData = malloc(sizeof(EventData_t));
478 eventData->node_event = afb_daemon_make_event ("node-availibility");
481 if (!eventData || !afb_event_is_valid(eventData->node_event)) {
482 afb_req_fail_f (request, "create-event", "Cannot create or register event");
487 if (afb_req_subscribe(request, eventData->node_event) != 0) {
489 afb_req_fail_f (request, "subscribe-event", "Cannot subscribe to event");
493 afb_req_success(request,NULL,"event subscription successful");
499 STATIC void ucs2_writei2c_CB (void *result_ptr, void *request_ptr) {
502 afb_req *req = (afb_req *)request_ptr;
503 Ucs_I2c_ResultCode_t *res = (Ucs_I2c_ResultCode_t *)result_ptr;
506 afb_req_fail(*req, "processing","busy or lost initialization");
508 else if (*res != UCS_I2C_RES_SUCCESS){
509 afb_req_fail_f(*req, "error-result", "result code: %d", *res);
512 afb_req_success(*req, NULL, "success");
519 AFB_NOTICE("write_i2c: ambiguous response data");
523 /* write a single i2c command */
524 STATIC void ucs2_writei2c_cmd(struct afb_req request, json_object *j_obj) {
526 static uint8_t i2c_data[I2C_MAX_DATA_SZ];
527 uint8_t i2c_data_sz = 0;
528 uint16_t node_addr = 0;
529 struct afb_req *async_req_ptr = NULL;
531 node_addr = (uint16_t)json_object_get_int(json_object_object_get(j_obj, "node"));
532 AFB_NOTICE("node_address: 0x%02X", node_addr);
534 if (node_addr == 0) {
535 afb_req_fail_f(request, "query-params","params wrong or missing");
539 if (json_object_get_type(json_object_object_get(j_obj, "data"))==json_type_array) {
540 int size = json_object_array_length(json_object_object_get(j_obj, "data"));
541 if ((size > 0) && (size <= I2C_MAX_DATA_SZ)) {
545 struct json_object *j_elem;
546 struct json_object *j_arr = json_object_object_get(j_obj, "data");
548 for (i = 0; i < size; i++) {
551 j_elem = json_object_array_get_idx(j_arr, i);
552 val = json_object_get_int(j_elem);
553 if ((val < 0) && (val > 0xFF)){
557 i2c_data[i] = (uint8_t)json_object_get_int(j_elem);
560 i2c_data_sz = (uint8_t)i;
564 if (i2c_data_sz == 0) {
565 AFB_NOTICE("data: invalid or not found");
566 afb_req_fail_f(request, "query-params","params wrong or missing");
570 async_req_ptr = malloc(sizeof(afb_req));
571 *async_req_ptr = request;
573 if (UCSI_I2CWrite( &ucsContextS->ucsiData, /* UCSI_Data_t *pPriv*/
574 node_addr, /* uint16_t targetAddress*/
575 false, /* bool isBurst*/
576 0u, /* block count */
577 0x2Au, /* i2c slave address */
578 0x03E8u, /* timeout 1000 milliseconds */
579 i2c_data_sz, /* uint8_t dataLen */
580 &i2c_data[0], /* uint8_t *pData */
581 &ucs2_writei2c_CB, /* callback*/
582 (void*)async_req_ptr /* callback argument */
584 /* asynchronous command is running */
585 afb_req_addref(request);
588 AFB_NOTICE("i2c write: scheduling command failed");
589 afb_req_fail_f(request, "query-command-queue","command queue overload");
591 async_req_ptr = NULL;
599 /* parse array or single command */
600 PUBLIC void ucs2_writei2c (struct afb_req request) {
602 struct json_object *j_obj;
604 /* check UNICENS is initialised */
606 afb_req_fail_f(request, "unicens-init","Should Load Config before using setvol");
610 j_obj = afb_req_json(request);
612 afb_req_fail_f(request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
616 AFB_DEBUG("request: %s", json_object_to_json_string(j_obj));
618 if (json_object_get_type(j_obj)==json_type_array) {
621 int len = json_object_array_length(j_obj);
624 afb_req_fail_f(request, "query-array","query of multiple commands is not supported");
628 for (cnt = 0; cnt < len; cnt++) {
630 json_object *j_cmd = json_object_array_get_idx(j_obj, cnt);
631 ucs2_writei2c_cmd(request, j_cmd);
635 ucs2_writei2c_cmd(request, j_obj);
642 PUBLIC int ucs2_initbinding(void) {
643 #ifndef DISABLE_AUTOSTART
644 char *filename = GetDefaultConfig();
645 if (filename != NULL) {
647 AFB_NOTICE("AUTO-LOAD configuration: %s", filename);
648 if (StartConfiguration(filename) == 0) {
649 AFB_NOTICE("AUTO-LOAD successful");
651 AFB_NOTICE("AUTO-LOAD failed");