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 */
27 #include <systemd/sd-event.h>
28 #include <sys/types.h>
39 #include "ucs_binding.h"
40 #include "ucs_interface.h"
44 #define MAX_FILENAME_LEN (100)
45 #define RX_BUFFER (64)
47 /** Internal structure, enabling multiple instances of this component.
48 * \note Do not access any of this variables.
53 char fileName[MAX_FILENAME_LEN];
54 uint8_t rxBuffer[RX_BUFFER];
63 UCSI_channelsT *channels;
66 static ucsContextT *ucsContextS;
68 STATIC void ucs2_write_i2c_response(void *result_ptr, void *request_ptr);
70 PUBLIC void UcsXml_CB_OnError(const char format[], uint16_t vargsCnt, ...) {
71 /*AFB_DEBUG (afbIface, format, args); */
73 va_start (args, vargsCnt);
74 vfprintf (stderr, format, args);
79 va_start(argptr, vargsCnt);
80 vsprintf(outbuf, format, argptr);
85 PUBLIC uint16_t UCSI_CB_OnGetTime(void *pTag) {
86 struct timespec currentTime;
90 if (clock_gettime(CLOCK_MONOTONIC_RAW, ¤tTime)) {
95 timer = (uint16_t) ((currentTime.tv_sec * 1000 ) + ( currentTime.tv_nsec / 1000000 ));
99 STATIC int onTimerCB (sd_event_source* source,uint64_t timer, void* pTag) {
100 ucsContextT *ucsContext = (ucsContextT*) pTag;
102 sd_event_source_unref(source);
103 UCSI_Timeout(&ucsContext->ucsiData);
108 /* UCS2 Interface Timer Callback */
109 PUBLIC void UCSI_CB_OnSetServiceTimer(void *pTag, uint16_t timeout) {
111 /* set a timer with 250ms accuracy */
112 sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
113 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, onTimerCB, pTag);
118 * \brief Callback when ever an Unicens forms a human readable message.
119 * This can be error events or when enabled also debug messages.
120 * \note This function must be implemented by the integrator
121 * \param pTag - Pointer given by the integrator by UCSI_Init
122 * \param format - Zero terminated format string (following printf rules)
123 * \param vargsCnt - Amount of parameters stored in "..."
125 void UCSI_CB_OnUserMessage(void *pTag, bool isError, const char format[],
126 uint16_t vargsCnt, ...) {
130 va_start(argptr, vargsCnt);
131 vsprintf(outbuf, format, argptr);
137 /** UCSI_Service cannot be called directly within UNICENS context, need to service stack through mainloop */
138 STATIC int OnServiceRequiredCB (sd_event_source *source, uint64_t usec, void *pTag) {
139 ucsContextT *ucsContext = (ucsContextT*) pTag;
141 sd_event_source_unref(source);
142 UCSI_Service(&ucsContext->ucsiData);
146 /* UCS Callback fire when ever UNICENS needs to be serviced */
147 PUBLIC void UCSI_CB_OnServiceRequired(void *pTag) {
149 /* push an asynchronous request for loopback to call UCSI_Service */
150 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, 0, 0, OnServiceRequiredCB, pTag);
153 /* Callback when ever this UNICENS wants to send a message to INIC. */
154 PUBLIC void UCSI_CB_OnTxRequest(void *pTag, const uint8_t *pData, uint32_t len) {
155 ucsContextT *ucsContext = (ucsContextT*) pTag;
156 CdevData_t *cdevTx = &ucsContext->tx;
159 if (NULL == pData || 0 == len) return;
161 if (O_RDONLY == cdevTx->fileFlags) return;
162 if (-1 == cdevTx->fileHandle)
163 cdevTx->fileHandle = open(cdevTx->fileName, cdevTx->fileFlags);
164 if (-1 == cdevTx->fileHandle)
168 ssize_t written = write(cdevTx->fileHandle, &pData[total], (len - total));
171 /* Silently ignore write error (only occur in non-blocking mode) */
174 total += (uint32_t) written;
179 * \brief Callback when UNICENS instance has been stopped.
180 * \note This event can be used to free memory holding the resources
181 * passed with UCSI_NewConfig
182 * \note This function must be implemented by the integrator
183 * \param pTag - Pointer given by the integrator by UCSI_Init
185 void UCSI_CB_OnStop(void *pTag) {
186 AFB_NOTICE ("UNICENS stopped");
190 /** This callback will be raised, when ever an applicative message on the control channel arrived */
191 void UCSI_CB_OnAmsMessageReceived(void *pTag)
193 /* If not interested, just ignore this event.
194 Otherwise UCSI_GetAmsMessage may now be called asynchronous (mainloop) to get the content.
195 Don't forget to call UCSI_ReleaseAmsMessage after that */
198 void UCSI_CB_OnRouteResult(void *pTag, uint16_t routeId, bool isActive)
202 void UCSI_CB_OnGpioStateChange(void *pTag, uint16_t nodeAddress, uint8_t gpioPinId, bool isHighState)
206 bool Cdev_Init(CdevData_t *d, const char *fileName, bool read, bool write)
208 if (NULL == d || NULL == fileName) goto OnErrorExit;
210 memset(d, 0, sizeof(CdevData_t));
211 strncpy(d->fileName, fileName, MAX_FILENAME_LEN);
215 d->fileFlags = O_RDWR | O_NONBLOCK;
217 d->fileFlags = O_RDONLY | O_NONBLOCK;
219 d->fileFlags = O_WRONLY | O_NONBLOCK;
221 /* open file to enable event loop */
222 d->fileHandle = open(d->fileName, d->fileFlags);
223 if (d->fileHandle <= 0) goto OnErrorExit;
231 static bool InitializeCdevs(ucsContextT *ucsContext)
233 if(!Cdev_Init(&ucsContext->tx, CONTROL_CDEV_TX, false, true))
235 if(!Cdev_Init(&ucsContext->rx, CONTROL_CDEV_RX, true, false))
240 /* Callback fire when something is avaliable on MOST cdev */
241 int onReadCB (sd_event_source* src, int fileFd, uint32_t revents, void* pTag) {
242 ucsContextT *ucsContext =( ucsContextT*) pTag;
244 uint8_t pBuffer[RX_BUFFER];
247 len = read (ucsContext->rx.fileHandle, &pBuffer, sizeof(pBuffer));
250 ok= UCSI_ProcessRxData(&ucsContext->ucsiData, pBuffer, (uint16_t)len);
252 AFB_DEBUG ("Buffer overrun (not handle)");
253 /* Buffer overrun could replay pBuffer */
258 STATIC UcsXmlVal_t* ParseFile(struct afb_req request) {
263 UcsXmlVal_t* ucsConfig;
265 const char *filename = afb_req_value(request, "filename");
267 afb_req_fail_f (request, "filename-missing", "No filename given");
271 fdHandle = open(filename, O_RDONLY);
273 afb_req_fail_f (request, "fileread-error", "File not accessible: '%s' err=%s", filename, strerror(fdHandle));
277 /* read file into buffer as a \0 terminated string */
278 fstat(fdHandle, &fdStat);
279 xmlBuffer = (char*)alloca(fdStat.st_size + 1);
280 readSize = read(fdHandle, xmlBuffer, fdStat.st_size);
282 xmlBuffer[readSize] = '\0'; /* In any case, terminate it. */
284 if (readSize != fdStat.st_size) {
285 afb_req_fail_f (request, "fileread-fail", "File to read fullfile '%s' size(%d!=%d)", filename, (int)readSize, (int)fdStat.st_size);
289 ucsConfig = UcsXml_Parse(xmlBuffer);
291 afb_req_fail_f (request, "filexml-error", "File XML invalid: '%s'", filename);
301 STATIC int volOnSvcCB (sd_event_source* source,uint64_t timer, void* pTag) {
302 ucsContextT *ucsContext = (ucsContextT*) pTag;
304 sd_event_source_unref(source);
305 UCSI_Vol_Service(&ucsContext->ucsiData);
310 /* This callback is fire each time an volume event wait in the queue */
311 void volumeCB (uint16_t timeout) {
313 sd_event_now(afb_daemon_get_event_loop(), CLOCK_BOOTTIME, &usec);
314 sd_event_add_time(afb_daemon_get_event_loop(), NULL, CLOCK_MONOTONIC, usec + (timeout*1000), 250, volOnSvcCB, ucsContextS);
317 STATIC int volSndCmd (struct afb_req request, struct json_object *commandJ, ucsContextT *ucsContext) {
319 struct json_object *nameJ, *channelJ, *volJ;
321 enum json_type jtype= json_object_get_type(commandJ);
323 case json_type_array:
324 if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 0)), "%d", &numid)) {
325 afb_req_fail_f (request, "channel-invalid","command=%s channel is not an integer", json_object_get_string (channelJ));
328 if (!sscanf (json_object_get_string (json_object_array_get_idx(commandJ, 1)), "%d", &vol)) {
329 afb_req_fail_f (request, "vol-invalid","command=%s vol is not an integer", json_object_get_string (channelJ));
334 case json_type_object:
335 if (json_object_object_get_ex (commandJ, "numid", &channelJ)) {
336 if (!sscanf (json_object_get_string (channelJ), "%d", &numid)) {
337 afb_req_fail_f (request, "channel-invalid","command=%s numid is not an integer", json_object_get_string (channelJ));
341 if (json_object_object_get_ex (commandJ, "channel", &nameJ)) {
343 const char *name = json_object_get_string(nameJ);
345 for (idx =0; ucsContext->channels[idx].name != NULL; idx++) {
346 if (!strcasecmp(ucsContext->channels[idx].name, name)) {
347 numid = ucsContext->channels[idx].numid;
351 if (ucsContext->channels[idx].name == NULL) {
352 afb_req_fail_f (request, "channel-invalid","command=%s channel name does not exist", name);
356 afb_req_fail_f (request, "channel-invalid","command=%s no valid channel name or channel", json_object_get_string(commandJ));
361 if (!json_object_object_get_ex (commandJ, "volume", &volJ)) {
362 afb_req_fail_f (request, "vol-missing","command=%s vol not present", json_object_get_string (commandJ));
366 if (!sscanf (json_object_get_string (volJ), "%d", &vol)) {
367 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));
374 afb_req_fail_f (request, "setvol-invalid","command=%s not valid JSON Volume Command", json_object_get_string(commandJ));
379 /* Fulup what's append when channel or vol are invalid ??? */
380 err = UCSI_Vol_Set (&ucsContext->ucsiData, numid, (uint8_t) vol);
382 /* Fulup this might only be a warning (not sure about it) */
383 afb_req_fail_f (request, "vol-refused","command=%s vol was refused by UNICENS", json_object_get_string (volJ));
393 PUBLIC void ucs2_volume (struct afb_req request) {
394 struct json_object *queryJ;
397 /* check UNICENS is initialised */
399 afb_req_fail_f (request, "UNICENS-init","Should Load Config before using setvol");
403 queryJ = afb_req_json(request);
405 afb_req_fail_f (request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
409 enum json_type jtype= json_object_get_type(queryJ);
411 case json_type_array:
412 for (int idx=0; idx < json_object_array_length (queryJ); idx ++) {
413 err= volSndCmd (request, json_object_array_get_idx (queryJ, idx), ucsContextS);
414 if (err) goto OnErrorExit;
418 case json_type_object:
419 err = volSndCmd (request, queryJ, ucsContextS);
420 if (err) goto OnErrorExit;
424 afb_req_fail_f (request, "query-notarray","query=%s not valid JSON Volume Command Array", afb_req_value(request,""));
429 afb_req_success(request,NULL,NULL);
436 PUBLIC void ucs2_initialise (struct afb_req request) {
437 static UcsXmlVal_t *ucsConfig;
438 static ucsContextT ucsContext;
440 sd_event_source *evtSource;
443 /* Read and parse XML file */
444 ucsConfig = ParseFile (request);
445 if (NULL == ucsConfig) goto OnErrorExit;
447 /* When ucsContextS is set, do not initalize UNICENS, CDEVs or system hooks, just load new XML */
450 if (!ucsContextS && !InitializeCdevs(&ucsContext)) {
451 afb_req_fail_f (request, "devnit-error", "Fail to initialise device [rx=%s tx=%s]", CONTROL_CDEV_RX, CONTROL_CDEV_TX);
455 /* Initialise UNICENS Config Data Structure */
456 UCSI_Init(&ucsContext.ucsiData, &ucsContext);
458 /* register aplayHandle file fd into binder mainloop */
459 err = sd_event_add_io(afb_daemon_get_event_loop(), &evtSource, ucsContext.rx.fileHandle, EPOLLIN, onReadCB, &ucsContext);
461 afb_req_fail_f (request, "register-mainloop", "Cannot hook events to mainloop");
465 /* init UNICENS Volume Library */
466 ucsContext.channels = UCSI_Vol_Init (&ucsContext.ucsiData, volumeCB);
467 if (!ucsContext.channels) {
468 afb_req_fail_f (request, "register-volume", "Could not enqueue new Unicens config");
471 /* save this in a statical variable until ucs2vol move to C */
472 ucsContextS = &ucsContext;
474 /* Initialise UNICENS with parsed config */
475 if (!UCSI_NewConfig(&ucsContext.ucsiData, ucsConfig)) {
476 afb_req_fail_f (request, "UNICENS-init", "Fail to initialize UNICENS");
480 afb_req_success(request,NULL,"UNICENS-active");
487 // List Avaliable Configuration Files
488 PUBLIC void ucs2_listconfig (struct afb_req request) {
489 struct json_object *queryJ, *tmpJ, *responseJ;
491 char *dirPath, *dirList;
494 queryJ = afb_req_json(request);
495 if (queryJ && json_object_object_get_ex (queryJ, "cfgpath" , &tmpJ)) {
496 strdup (json_object_get_string(tmpJ));
498 dirList = strdup (UCS2_CFG_PATH);
499 AFB_NOTICE ("fgpath:missing uses UCS2_CFG_PATH=%s", UCS2_CFG_PATH);
502 responseJ = json_object_new_array();
503 for (dirPath= strtok(dirList, ":"); dirPath && *dirPath; dirPath=strtok(NULL,":")) {
504 struct dirent *dirEnt;
506 dirHandle = opendir (dirPath);
508 AFB_NOTICE ("ucs2_listconfig dir=%s not readable", dirPath);
513 AFB_NOTICE ("ucs2_listconfig scanning: %s", dirPath);
514 while ((dirEnt = readdir(dirHandle)) != NULL) {
515 // Unknown type is accepted to support dump filesystems
516 if (dirEnt->d_type == DT_REG || dirEnt->d_type == DT_UNKNOWN) {
517 struct json_object *pathJ = json_object_new_object();
518 json_object_object_add(pathJ, "dirpath", json_object_new_string(dirPath));
519 json_object_object_add(pathJ, "basename", json_object_new_string(dirEnt->d_name));
520 json_object_array_add(responseJ, pathJ);
527 if (!error) afb_req_success(request,responseJ,NULL);
530 snprintf (info, sizeof(info), "[%d] where not scanned", error);
531 afb_req_success(request,responseJ, info);
537 PUBLIC void ucs2_monitor (struct afb_req request) {
539 afb_req_success(request,NULL,"UNICENS-to_be_done");
542 #define MUTE_VALUE 0x03FFU
543 #define MUTE_VALUE_HB 0x03U
544 #define MUTE_VALUE_LB 0xFFU
546 #define CONTROL_MASTER 0x07U
547 #define CONTROL_CH_1 0x08U
548 #define CONTROL_CH_2 0x09U
550 #define UCSB_I2C_MAX_PAYLOAD 32
552 PUBLIC void ucs2_write_i2c (struct afb_req request) {
554 struct json_object *j_obj;
555 static uint8_t tx_payload[UCSB_I2C_MAX_PAYLOAD];
556 uint8_t tx_payload_sz = 0;
557 uint16_t node_addr = 0;
559 /* check UNICENS is initialised */
561 afb_req_fail_f(request, "unicens-init","Should Load Config before using setvol");
565 j_obj = afb_req_json(request);
567 afb_req_fail_f(request, "query-notjson","query=%s not a valid json entry", afb_req_value(request,""));
571 node_addr = (uint16_t)json_object_get_int(json_object_object_get(j_obj, "node_address"));
572 AFB_NOTICE("node_address: 0x%02X", node_addr);
574 if (node_addr == 0) {
575 afb_req_fail_f(request, "query-params","params wrong or missing");
579 if (json_object_get_type(json_object_object_get(j_obj, "i2c_data"))==json_type_array) {
580 int size = json_object_array_length(json_object_object_get(j_obj, "i2c_data"));
581 if ((size > 0) && (size <= UCSB_I2C_MAX_PAYLOAD)) {
585 struct json_object *j_elem;
586 struct json_object *j_arr = json_object_object_get(j_obj, "i2c_data");
588 for (i = 0; i < size; i++) {
591 j_elem = json_object_array_get_idx(j_arr, i);
592 val = json_object_get_int(j_elem);
593 if ((val < 0) && (val > 0xFF)){
597 tx_payload[i] = (uint8_t)json_object_get_int(j_elem);
600 tx_payload_sz = (uint8_t)i;
604 if (tx_payload_sz == 0) {
605 AFB_NOTICE("i2c_data: invalid or not found");
606 afb_req_fail_f(request, "query-params","params wrong or missing");
610 UCSI_I2CWrite(&ucsContextS->ucsiData,/*UCSI_Data_t *pPriv*/
611 node_addr, /*uint16_t targetAddress*/
612 false, /*bool isBurst*/
613 0u, /* block count */
614 0x2Au, /* i2c slave address */
615 0x03E8u, /* timeout 1000 milliseconds */
616 tx_payload_sz, /* uint8_t dataLen */
617 &tx_payload[0], /* uint8_t *pData */
618 ucs2_write_i2c_response,
622 afb_req_success(request,NULL,"done!!!");
628 STATIC void ucs2_write_i2c_response(void *result_ptr, void *request_ptr) {
631 afb_req *req = (afb_req *)request_ptr;
632 Ucs_I2c_ResultCode_t *res = (Ucs_I2c_ResultCode_t *)result_ptr;
635 afb_req_fail(*req, NULL,"failure, result code not provided");
637 else if (*res != UCS_I2C_RES_SUCCESS){
638 afb_req_fail_f(*req, NULL, "failure, result code: %d", *res);
641 afb_req_success(*req, NULL, "success");
645 AFB_NOTICE("write_i2c: ambiguous response data");