7cb60be807d1114a6a7006d421533442a979414a
[ipc/ipcdev.git] / packages / ti / sdo / ipc / nsremote / NameServerRemoteNotify.c
1 /*
2  * Copyright (c) 2012-2014, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*
33  *  ======== NameServerRemoteNotify.c ========
34  */
36 /* Remove Windows strncpy warning */
37 #define _CRT_SECURE_NO_DEPRECATE 1
39 #include <xdc/std.h>
40 #include <string.h>
41 #include <stdlib.h>
43 #include <xdc/runtime/Assert.h>
44 #include <xdc/runtime/Error.h>
45 #include <xdc/runtime/knl/ISync.h>
47 #include <ti/sysbios/BIOS.h>
48 #include <ti/sysbios/hal/Cache.h>
49 #include <ti/sysbios/knl/Swi.h>
50 #include <ti/sysbios/knl/Semaphore.h>
52 #include "package/internal/NameServerRemoteNotify.xdc.h"
54 #include <ti/sdo/ipc/Ipc.h>
55 #include <ti/sdo/ipc/_Notify.h>
56 #include <ti/sdo/ipc/_GateMP.h>
57 #include <ti/sdo/ipc/_SharedRegion.h>
58 #include <ti/sdo/utils/_MultiProc.h>
59 #include <ti/sdo/utils/_NameServer.h>
61 /* Need to use reserved notify events */
62 #undef NameServerRemoteNotify_notifyEventId
63 #define NameServerRemoteNotify_notifyEventId \
64         ti_sdo_ipc_nsremote_NameServerRemoteNotify_notifyEventId + \
65                     (UInt32)((UInt32)Notify_SYSTEMKEY << 16)
67 /* private constant values */
68 #define NameServerRemoteNotify_RequestMsg       1
69 #define NameServerRemoteNotify_ResponseMsg      2
71 /*
72  *************************************************************************
73  *                       Instance functions
74  *************************************************************************
75  */
76 Int NameServerRemoteNotify_Instance_init(NameServerRemoteNotify_Object *obj,
77         UInt16 remoteProcId, const NameServerRemoteNotify_Params *params,
78         Error_Block *eb)
79 {
80     Int               offset = 0;
81     Int               status;
82     Semaphore_Params  semParams;
83     Semaphore_Handle  semHandle;
84     Swi_Params        swiParams;
85     Swi_Handle        swiHandle;
87     /* Assert that a NameServerRemoteNotify_Params has been supplied */
88     Assert_isTrue(params != NULL, Ipc_A_nullArgument);
90     /* Assert that remoteProcId is valid */
91     Assert_isTrue(remoteProcId != MultiProc_self() &&
92                   remoteProcId != MultiProc_INVALIDID,
93                   Ipc_A_invParam);
95     /* determine the offset based upon own id and remote's id */
96     if (MultiProc_self() > remoteProcId) {
97         offset = 1;
98     }
100     obj->regionId = SharedRegion_getId(params->sharedAddr);
101     obj->localState = NameServerRemoteNotify_IDLE;
102     obj->remoteState = NameServerRemoteNotify_IDLE;
104     /* assert that sharedAddr is cache aligned */
105     Assert_isTrue(((UInt32)params->sharedAddr %
106             SharedRegion_getCacheLineSize(obj->regionId) == 0),
107             Ipc_A_addrNotCacheAligned);
109     /* asset message structure size is cache aligned */
110     Assert_isTrue((sizeof(NameServerRemoteNotify_Message) %
111             SharedRegion_getCacheLineSize(obj->regionId)) == 0,
112             NameServerRemoteNotify_A_messageSize);
114     obj->msg[0] = (NameServerRemoteNotify_Message *)(params->sharedAddr);
115     obj->msg[1] = (NameServerRemoteNotify_Message *)((UInt32)obj->msg[0] +
116                           sizeof(NameServerRemoteNotify_Message));
117     obj->gate = params->gate;
118     obj->remoteProcId = remoteProcId;
120     /* construct the remoteWait semaphore */
121     semHandle = NameServerRemoteNotify_Instance_State_semRemoteWait(obj);
122     Semaphore_Params_init(&semParams);
123     Semaphore_construct(Semaphore_struct(semHandle), 0, &semParams);
125     /* construct the multiBlock semaphore */
126     semHandle = NameServerRemoteNotify_Instance_State_semMultiBlock(obj);
127     Semaphore_Params_init(&semParams);
128     Semaphore_construct(Semaphore_struct(semHandle), 1, &semParams);
130     /* construct swi which handles the request message */
131     swiHandle = NameServerRemoteNotify_Instance_State_swiRequest(obj);
132     Swi_Params_init(&swiParams);
133     swiParams.arg0 = (UArg)obj;
134     swiParams.priority = 0; /* lowest priority */
135     Swi_construct(Swi_struct(swiHandle),
136              (ti_sysbios_knl_Swi_FuncPtr)NameServerRemoteNotify_swiFxnRequest,
137              &swiParams, eb);
139     /* construct swi which handles the response message */
140     swiHandle = NameServerRemoteNotify_Instance_State_swiResponse(obj);
141     Swi_Params_init(&swiParams);
142     swiParams.arg0 = (UArg)obj;
143     swiParams.priority = 0; /* lowest priority */
144     Swi_construct(Swi_struct(swiHandle),
145              (ti_sysbios_knl_Swi_FuncPtr)NameServerRemoteNotify_swiFxnResponse,
146              &swiParams, eb);
148     /* initialize own side of message struct only */
149     obj->msg[offset]->requestStatus = 0;
150     obj->msg[offset]->value = 0;
151     obj->msg[offset]->valueLen = 0;
153     memset(obj->msg[offset]->instanceName, 0,
154                sizeof(obj->msg[offset]->instanceName));
155     memset(obj->msg[offset]->name, 0,
156                sizeof(obj->msg[offset]->name));
158     /* determine cacheability of the object from the regionId */
159     obj->cacheEnable = SharedRegion_isCacheEnabled(obj->regionId);
160     if (obj->cacheEnable) {
161         /* write back shared memory that was modified */
162         Cache_wbInv(obj->msg[offset], sizeof(NameServerRemoteNotify_Message),
163                     Cache_Type_ALL, TRUE);
164     }
166     /* register notify callback function to handle message notifications */
167     status = Notify_registerEventSingle(remoteProcId, 0,
168             NameServerRemoteNotify_notifyEventId,
169             (Notify_FnNotifyCbck)NameServerRemoteNotify_cbFxn, (UArg)obj);
171     /* if not successful return */
172     if (status < 0) {
173         Error_raise(eb, ti_sdo_ipc_Ipc_E_internal, 0, 0);
174         return (1);
175     }
177     /* register the remote driver with NameServer */
178     ti_sdo_utils_NameServer_registerRemoteDriver(
179             NameServerRemoteNotify_Handle_upCast(obj), remoteProcId);
181     return (0);
184 /*
185  *  ======== NameServerRemoteNotify_Instance_finalize ========
186  */
187 Void NameServerRemoteNotify_Instance_finalize(
188         NameServerRemoteNotify_Object *obj, Int status)
190     Semaphore_Handle  semHandle;
191     Swi_Handle        swiHandle;
193     if (status == 0) {
194         /* unregister remote driver from NameServer module */
195         ti_sdo_utils_NameServer_unregisterRemoteDriver(obj->remoteProcId);
197         /* unregister event from Notify module */
198         Notify_unregisterEventSingle(obj->remoteProcId, 0,
199                 NameServerRemoteNotify_notifyEventId);
200     }
202     semHandle = NameServerRemoteNotify_Instance_State_semRemoteWait(obj);
203     if (semHandle != NULL) {
204         Semaphore_destruct(Semaphore_struct(semHandle));
205     }
207     semHandle = NameServerRemoteNotify_Instance_State_semMultiBlock(obj);
208     if (semHandle != NULL) {
209         Semaphore_destruct(Semaphore_struct(semHandle));
210     }
212     swiHandle = NameServerRemoteNotify_Instance_State_swiRequest(obj);
213     if (swiHandle != NULL) {
214         Swi_destruct(Swi_struct(swiHandle));
215     }
217     swiHandle = NameServerRemoteNotify_Instance_State_swiResponse(obj);
218     if (swiHandle != NULL) {
219         Swi_destruct(Swi_struct(swiHandle));
220     }
223 /*
224  *************************************************************************
225  *                       Module functions
226  *************************************************************************
227  */
229 /*
230  *  ======== NameServerRemoteNotify_attach ========
231  */
232 Int NameServerRemoteNotify_attach(UInt16 remoteProcId, Ptr sharedAddr)
234     NameServerRemoteNotify_Params nsrParams;
235     NameServerRemoteNotify_Handle handle;
236     Int status = NameServerRemoteNotify_E_FAIL;
237     Error_Block eb;
239     /* Assert that the default GateMP is not NULL */
240     Assert_isTrue(GateMP_getDefaultRemote() != NULL, Ipc_A_internal);
242     Error_init(&eb);
244     /* Use default GateMP */
245     NameServerRemoteNotify_Params_init(&nsrParams);
246     nsrParams.gate = (ti_sdo_ipc_GateMP_Handle)GateMP_getDefaultRemote();
248     /* determine the address */
249     nsrParams.sharedAddr = sharedAddr;
251     /* create only if notify driver has been created to remote proc */
252     if (Notify_intLineRegistered(remoteProcId, 0)) {
253         handle = NameServerRemoteNotify_create(remoteProcId,
254                                                &nsrParams,
255                                                &eb);
256         if (handle != NULL) {
257             status = NameServerRemoteNotify_S_SUCCESS;
258         }
259     }
261     return (status);
264 /*
265  *  ======== NameServerRemoteNotify_cbFxn ========
266  */
267 Void NameServerRemoteNotify_cbFxn(UInt16 procId, UInt16 lineId, UInt32 eventId,
268         UArg arg, UInt32 payload)
270     NameServerRemoteNotify_Object *obj;
271     Swi_Handle swiHandle = NULL;
273     obj = (NameServerRemoteNotify_Object *)arg;
276     switch (payload)
277     {
278         case NameServerRemoteNotify_RequestMsg:
279             swiHandle = NameServerRemoteNotify_Instance_State_swiRequest(obj);
281             /* set object state (used by ROV) */
282             obj->remoteState = NameServerRemoteNotify_RECEIVE_REQUEST;
283             break;
285         case NameServerRemoteNotify_ResponseMsg:
286             swiHandle = NameServerRemoteNotify_Instance_State_swiResponse(obj);
288             /* set object state (used by ROV) */
289             obj->localState = NameServerRemoteNotify_RECEIVE_RESPONSE;
290             break;
292         default:
293             /* We should never get here but assert if we do */
294             Assert_isTrue(swiHandle != NULL, Ipc_A_internal);
295     }
297     Swi_post(swiHandle);
300 /*
301  *  ======== NameServerRemoteNotify_detach ========
302  */
303 Int NameServerRemoteNotify_detach(UInt16 remoteProcId)
305     NameServerRemoteNotify_Handle handle;
306     Int status = NameServerRemoteNotify_S_SUCCESS;
308     for (handle = NameServerRemoteNotify_Object_first(); handle != NULL;
309         handle = NameServerRemoteNotify_Object_next(handle)) {
310         if (handle->remoteProcId == remoteProcId) {
311             break;
312         }
313     }
315     if (handle == NULL) {
316         status = NameServerRemoteNotify_E_FAIL;
317     }
318     else {
319         NameServerRemoteNotify_delete(&handle);
320     }
322     return (status);
325 /*
326  *  ======== NameServerRemoteNotify_get ========
327  */
328 Int NameServerRemoteNotify_get(NameServerRemoteNotify_Object *obj,
329         String instanceName, String name, Ptr value, UInt32 *valueLen,
330         ISync_Handle syncHandle, Error_Block *eb)
332     Int len;
333     Int retval = NameServer_E_NOTFOUND;
334     Int offset = 0;
335     Int status;
336     Int notifyStatus;
337     Semaphore_Handle semRemoteWait;
338     Semaphore_Handle semMultiBlock;
340     Assert_isTrue(*valueLen <= 300, NameServerRemoteNotify_A_invalidValueLen);
342     semRemoteWait = NameServerRemoteNotify_Instance_State_semRemoteWait(obj);
343     semMultiBlock = NameServerRemoteNotify_Instance_State_semMultiBlock(obj);
345     /* prevent multiple threads from entering */
346     Semaphore_pend(semMultiBlock, BIOS_WAIT_FOREVER);
348     if (MultiProc_self() > obj->remoteProcId) {
349         offset = 1;
350     }
352     if (obj->cacheEnable) {
353         /* Make sure there's no outstanding message */
354         Cache_inv(obj->msg[offset], sizeof(NameServerRemoteNotify_Message),
355                   Cache_Type_ALL, TRUE);
356     }
358     /* this is a request message */
359     obj->msg[offset]->requestStatus = 0;
360     obj->msg[offset]->valueLen = *valueLen;
362     /* copy the name of instance into shared memory */
363     len = strlen(instanceName);
364     strncpy((Char *)obj->msg[offset]->instanceName, instanceName, len + 1);
366     /* copy the name of nameserver entry into shared memory */
367     len = strlen(name);
368     strncpy((Char *)obj->msg[offset]->name, name, len + 1);
370     /* set object state (used by ROV) */
371     obj->localState = NameServerRemoteNotify_SEND_REQUEST;
373     if (obj->cacheEnable) {
374         Cache_wbInv(obj->msg[offset], sizeof(NameServerRemoteNotify_Message),
375                     Cache_Type_ALL, TRUE);
376     }
378     /*
379      *  Send the notification to remote processor. Do not wait here since
380      *  we hold the GateMP.
381      */
382     notifyStatus = Notify_sendEvent(obj->remoteProcId, 0,
383             NameServerRemoteNotify_notifyEventId,
384             NameServerRemoteNotify_RequestMsg, TRUE);
386     if (notifyStatus < 0) {
387         /* undo previous options */
388         obj->msg[offset]->valueLen = 0;
390         /* post the semaphore to make sure it doesn't block */
391         Semaphore_post(semMultiBlock);
393         return (retval);
394     }
396     /* pend here until we get a notification back from remote processor */
397     status = Semaphore_pend(semRemoteWait, NameServerRemoteNotify_timeout);
399     if (status == FALSE) {
400         retval = NameServer_E_TIMEOUT;
401     }
402     else {
403         /* getting here means we got the notification back */
405         if (obj->cacheEnable) {
406             Cache_inv(obj->msg[offset], sizeof(NameServerRemoteNotify_Message),
407                     Cache_Type_ALL, TRUE);
408         }
410         /* if successful request then copy to value */
411         if (obj->msg[offset]->requestStatus == TRUE) {
413             /* copy to value */
414             if (obj->msg[offset]->valueLen == sizeof(UInt32)) {
415                 memcpy(value, &(obj->msg[offset]->value), sizeof(UInt32));
416             }
417             else {
418                 memcpy(value, &(obj->msg[offset]->valueBuf),
419                        obj->msg[offset]->valueLen);
420             }
422             /* set length to amount of data that was copied */
423             *valueLen = obj->msg[offset]->valueLen;
425             /* set the status */
426             retval = NameServer_S_SUCCESS;
427         }
429         /* set object state (used by ROV) */
430         obj->localState = NameServerRemoteNotify_IDLE;
431     }
433     Semaphore_post(semMultiBlock);
435     return (retval);
438 /*
439  *  ======== NameServerRemoteNotify_sharedMemReq ========
440  */
441 SizeT NameServerRemoteNotify_sharedMemReq(Ptr sharedAddr)
443     /*
444      *  Two Message structs are required.
445      *  One for sending request and one for sending response.
446      */
447     if (ti_sdo_utils_MultiProc_numProcessors > 1) {
448         return (2 * sizeof(NameServerRemoteNotify_Message));
449     }
451     return (0);
454 /*
455  *  ======== NameServerRemoteNotify_swiFxnRequest ========
456  */
457 Void NameServerRemoteNotify_swiFxnRequest(UArg arg)
459     Int count = NameServer_E_FAIL;
460     Int remoteId;
461     UInt32 valueLen;
462     NameServer_Handle handle;
463     NameServerRemoteNotify_Object *obj;
464 #ifndef xdc_runtime_Assert_DISABLE_ALL
465     Int status;
466 #endif
468     obj = (NameServerRemoteNotify_Object *)arg;
470     /* compute index to remote message */
471     remoteId = (MultiProc_self() > obj->remoteProcId) ? 0 : 1;
473     if (obj->cacheEnable) {
474         Cache_inv(obj->msg[remoteId], sizeof(NameServerRemoteNotify_Message),
475                 Cache_Type_ALL, TRUE);
476     }
478     /* get the NameServer handle */
479     handle = NameServer_getHandle((String)obj->msg[remoteId]->instanceName);
480     valueLen = obj->msg[remoteId]->valueLen;
482     if (handle != NULL) {
483         /* Search for the NameServer entry */
484         if (valueLen == sizeof(UInt32)) {
485             count = NameServer_getLocalUInt32(handle,
486                 (String)obj->msg[remoteId]->name, &obj->msg[remoteId]->value);
487         }
488         else {
489             count = NameServer_getLocal(handle,
490                 (String)obj->msg[remoteId]->name,
491                 &obj->msg[remoteId]->valueBuf, &valueLen);
492         }
493     }
495     /*
496      *  If an entry was found, set requestStatus to TRUE
497      *  and valueLen to the size of data that was copied.
498      */
499     if (count == NameServer_S_SUCCESS) {
500         obj->msg[remoteId]->requestStatus = TRUE;
501         obj->msg[remoteId]->valueLen = valueLen;
502     }
504     /* set object state (used by ROV) */
505     obj->remoteState = NameServerRemoteNotify_SEND_RESPONSE;
507     if (obj->cacheEnable) {
508         Cache_wbInv(obj->msg[remoteId], sizeof(NameServerRemoteNotify_Message),
509                 Cache_Type_ALL, TRUE);
510     }
512     /* must wait to prevent dropped events, even though this is a swi */
513 #ifndef xdc_runtime_Assert_DISABLE_ALL
514     status =
515 #endif
516     Notify_sendEvent(obj->remoteProcId, 0,
517             NameServerRemoteNotify_notifyEventId,
518             NameServerRemoteNotify_ResponseMsg, TRUE);
520     /* The NS query could fail, but the reply should never fail */
521     Assert_isTrue(status >= 0, Ipc_A_internal);
523     /* set object state (used by ROV) */
524     obj->remoteState = NameServerRemoteNotify_IDLE;
527 /*
528  *  ======== NameServerRemoteNotify_swiFxnResponse ========
529  */
530 Void NameServerRemoteNotify_swiFxnResponse(UArg arg)
532     NameServerRemoteNotify_Object *obj;
533     Semaphore_Handle  sem;
535     obj = (NameServerRemoteNotify_Object *)arg;
537     /* post the semaphore to unblock waiting task */
538     sem = NameServerRemoteNotify_Instance_State_semRemoteWait(obj);
539     Semaphore_post(sem);
542 /*
543  *  ======== NameServerRemoteNotify_getHandle ========
544  */
545 NameServerRemoteNotify_Handle NameServerRemoteNotify_getHandle(
546     UInt16 remoteProcId)
548     NameServerRemoteNotify_Handle obj;
550     for (obj = NameServerRemoteNotify_Object_first(); obj != NULL;
551         obj = NameServerRemoteNotify_Object_next(obj)) {
552         if (obj->remoteProcId == remoteProcId) {
553             break;
554         }
555     }
557     return (obj);