summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRamsey Harris <ramsey@ti.com>2015-09-09 15:47:09 -0700
committerAngela Stegmaier <angelabaker@ti.com>2015-09-11 10:30:58 -0500
commit0f6488855893142d365f4d9e809e396cbd1dc506 (patch)
tree116c1a68fff95b9b7f718c4214a925f57414d596
parentd03ae134cf5ced8854c1c11c803cad415c777300 (diff)
downloadipc-0f6488855893142d365f4d9e809e396cbd1dc506.tar.gz
SDOCM00077054 NameServer UG needs to document calling contexts
Document the fact that NameServer_get cannot be called from Hwi or Swi context. This was the main point of the bug report.
-rw-r--r--packages/ti/ipc/NameServer.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/packages/ti/ipc/NameServer.h b/packages/ti/ipc/NameServer.h
index 1f8192a..30e6e55 100644
--- a/packages/ti/ipc/NameServer.h
+++ b/packages/ti/ipc/NameServer.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2012-2015, Texas Instruments Incorporated
+ * Copyright (c) 2012-2015 Texas Instruments Incorporated - http://www.ti.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
@@ -437,6 +437,10 @@ Ptr NameServer_addUInt32(NameServer_Handle handle, String name, UInt32 value);
* count = NameServer_get(handle, "foo", &value, &len, queryList);
* @endcode
*
+ * This API should be called only from task context. It cannot be called
+ * from Hwi or Swi context because it blocks waiting for a response from
+ * the remote processor.
+ *
* The NameServer_getLocal() call can be used for searching
* the local table only.
*