Removed registerTransportId from MessageQ.xdc file
authorRamsey Harris <ramsey@ti.com>
Thu, 15 Jan 2015 18:14:42 +0000 (10:14 -0800)
committerRobert Tivy <rtivy@ti.com>
Sat, 17 Jan 2015 01:06:36 +0000 (17:06 -0800)
The new register/unregister transport ID functions were in the
MessageQ XDC spec file. This caused them to be defined using the
long name (i.e. package prefix). They are intended to be called
by clients using the short name (like MessageQ_put).

packages/ti/ipc/MessageQ.h
packages/ti/sdo/ipc/MessageQ.c
packages/ti/sdo/ipc/MessageQ.xdc

index bcbd40632444ef3e33cd8949b53b4e00cdc32663..0ab7de5904f23ecdb4f47d6926079ce6a53f18f6 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2014 Texas Instruments Incorporated - http://www.ti.com
+ * 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
@@ -600,8 +600,6 @@ typedef Void (*MessageQ_PutHookFxn)(MessageQ_QueueId queueId, MessageQ_Msg msg);
 Bool MessageQ_registerTransport(IMessageQTransport_Handle handle,
                                 UInt16 rprocId, UInt priority);
 Void MessageQ_unregisterTransport(UInt16 rprocId, UInt priority);
-Bool MessageQ_registerTransportId(UInt tid, ITransport_Handle inst);
-Void MessageQ_unregisterTransportId(UInt tid);
 
 
 /* =============================================================================
@@ -833,6 +831,28 @@ Int MessageQ_free(MessageQ_Msg msg);
  */
 Int MessageQ_registerHeap(Ptr heap, UInt16 heapId);
 
+/*!
+ *  @brief      Register a transport instance for the given ID
+ *
+ *  Additional transport instances can be registered with the MessageQ
+ *  module. This allows for message delivery over selected transports.
+ *
+ *  To arrange for a message to be delivered using a registered transport,
+ *  the corresponding transport ID must be set in the message header by
+ *  calling MessageQ_setTransportId().
+ *
+ *  @param[in]  tid         Transport ID, must be 1-7 inclusive
+ *  @param[in]  inst        Transport instance handle
+ *
+ *  @return     Status result
+ *              - TRUE: transport handle successfully registered
+ *              - FALSE: failure, most likely transport ID already in use
+ *
+ *  @sa         MessageQ_setTransportId()
+ *  @sa         MessageQ_unregisterTransportId()
+ */
+Bool MessageQ_registerTransportId(UInt tid, ITransport_Handle inst);
+
 /*!
  *  @brief      Unregister a heap with MessageQ
  *
@@ -848,6 +868,17 @@ Int MessageQ_registerHeap(Ptr heap, UInt16 heapId);
  */
 Int MessageQ_unregisterHeap(UInt16 heapId);
 
+/*!
+ *  @brief      Unregister the transport instance for the given ID
+ *
+ *  Remove the registered transport instance for the give transport ID.
+ *
+ *  @param[in]  tid         Transport ID, must be 1-7 inclusive
+ *
+ *  @sa         MessageQ_registerTransportId()
+ */
+Void MessageQ_unregisterTransportId(UInt tid);
+
 /*!
  *  @brief      Sets the message tracing flag on a given message
  *
index 112dda39a2cc006ba5b7b878463dd18ec94834fc..3c130e84ed03813cf5b096e3beb2c3efba11b81c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2014, 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
@@ -92,6 +92,7 @@ typedef struct {
     #pragma FUNC_EXT_CALLED(MessageQ_getQueueId);
     #pragma FUNC_EXT_CALLED(MessageQ_put);
     #pragma FUNC_EXT_CALLED(MessageQ_registerHeap);
+    #pragma FUNC_EXT_CALLED(MessageQ_registerTransportId);
     #pragma FUNC_EXT_CALLED(MessageQ_setFreeHookFxn);
     #pragma FUNC_EXT_CALLED(MessageQ_setPutHookFxn);
     #pragma FUNC_EXT_CALLED(MessageQ_setReplyQueue);
@@ -847,9 +848,9 @@ Void ti_sdo_ipc_MessageQ_unregisterTransport(UInt16 procId, UInt priority)
 }
 
 /*
- *  ======== ti_sdo_ipc_MessageQ_registerTransportId ========
+ *  ======== MessageQ_registerTransportId ========
  */
-Bool ti_sdo_ipc_MessageQ_registerTransportId(UInt tid, ITransport_Handle inst)
+Bool MessageQ_registerTransportId(UInt tid, ITransport_Handle inst)
 {
     ti_sdo_ipc_MessageQ_TransportType type;
 
@@ -881,16 +882,16 @@ Bool ti_sdo_ipc_MessageQ_registerTransportId(UInt tid, ITransport_Handle inst)
 }
 
 /*
- *  ======== ti_sdo_ipc_MessageQ_registerTransportId ========
+ *  ======== MessageQ_unregisterTransportId ========
  */
-Bool ti_sdo_ipc_MessageQ_unregisterTransportId(UInt tid)
+Void MessageQ_unregisterTransportId(UInt tid)
 {
     /* forget the registered transport instance */
     MessageQ_module->regTrans[tid].transport = NULL;
     MessageQ_module->regTrans[tid].type =
             ti_sdo_ipc_MessageQ_TransportType_Invalid;
 
-    return (TRUE);
+    return;
 }
 
 
index ca32bb906664b8c9b487201278d9d189e67b31d2..711246c80b469ddbc6cea69d2e991f0fceec74b5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2014 Texas Instruments Incorporated - http://www.ti.com
+ * 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
@@ -586,7 +586,8 @@ module MessageQ
      *  @param(procId)      procId that transport communicaties with
      *  @param(priority)    priority of transport
      */
-     metaonly Void registerTransportMeta(IMessageQTransport.Handle transport, UInt16 procId, UInt priority);
+     metaonly Void registerTransportMeta(IMessageQTransport.Handle transport,
+             UInt16 procId, UInt priority);
 
     /*!
      *  ======== registerTransport ========
@@ -613,18 +614,6 @@ module MessageQ
      */
     Void unregisterTransport(UInt16 procId, UInt priority);
 
-    /*!
-     *  ======== registerTransportId ========
-     *  Register the transport instance for the given ID
-     */
-    Bool registerTransportId(UInt tid, ITransport.Handle inst);
-
-    /*!
-     *  ======== unregisterTransportId ========
-     *  Unregister the transport for the given ID
-     */
-    Bool unregisterTransportId(UInt tid);
-
 instance:
 
     /*!