![]() |
![]() |
This is the RM include file for the generic transport interface used by RM to exchange RM control signals and data between RM instances. More...
Data Structures | |
struct | Rm_Packet |
RM transport layer packet. More... | |
struct | Rm_TransportCallouts |
RM transport callout functions used by RM to allocate and send RM packets via the application data paths between RM instances. More... | |
struct | Rm_TransportCfg |
RM transport registration configuration structure. More... | |
struct | Rm_TransportReCfg |
RM transport reconfiguration structure. More... | |
Defines | |
#define | RM_TRANSPORT_PACKET_MAX_SIZE_BYTES (256) |
Maximum size of RM transport packet. | |
Typedefs | |
typedef void * | Rm_TransportHandle |
RM transport handle. | |
typedef void * | Rm_AppTransportHandle |
Application transport handle. Void casted application transport data structure. The Rm_AppTransportHandle provided by the application could be anything from a queue number to a pointer to an application transport data structure. RM will provide a Rm_AppTransportHandle to the application any time RM wants to alloc or send a packet via the transport callouts. | |
typedef void * | Rm_PacketHandle |
A void pointer to the start of a registered application transport packet buffer. The Rm_PacketHandle may be different from the Rm_Packet pointer based on the application transport. For example, for a QMSS based transport the Rm_PacketHandle may point to the beginning of a Host descriptor where as the Rm_Packet pointer would point to the beginning of the data buffer linked with the Host descriptor. | |
Enumerations | |
enum | Rm_pktType { Rm_pktType_RESOURCE_REQUEST = 0, Rm_pktType_RESOURCE_RESPONSE, Rm_pktType_NAMESERVER_REQUEST, Rm_pktType_NAMESERVER_RESPONSE } |
RM packet types. More... | |
Functions | |
Rm_TransportHandle | Rm_transportRegister (const Rm_TransportCfg *transportCfg, int32_t *result) |
int32_t | Rm_transportReconfig (Rm_TransportHandle transportHandle, const Rm_TransportReCfg *transportReCfg) |
int32_t | Rm_transportUnregister (Rm_TransportHandle transportHandle) |
int32_t | Rm_receiveGetPktServiceSrcName (const Rm_Packet *pkt, char *serviceInstName, int32_t charBufLen) |
int32_t | Rm_receiveGetPktSrcName (const Rm_Packet *pkt, char *pktInstName, int32_t charBufLen) |
int32_t | Rm_receivePacket (Rm_TransportHandle transportHandle, const Rm_Packet *pkt) |
This is the RM include file for the generic transport interface used by RM to exchange RM control signals and data between RM instances.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.