diff --git a/rm_transport.h b/rm_transport.h
index 6a961838b82e4b4ebf470a0dd06930c0a2aaf907..4fa569dfe982afee666296df83ebc2a25547c751 100644 (file)
--- a/rm_transport.h
+++ b/rm_transport.h
/**
- * @file rmtransport.h
+ * @file rm_transport.h
*
* @brief
* This is the RM include file for the generic transport interface used by RM to exchange
*
* \par
* ============================================================================
- * @n (C) Copyright 2012, Texas Instruments, Inc.
+ * @n (C) Copyright 2012-2013, Texas Instruments, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* \par
*/
-#ifndef RMTRANSPORT_H_
-#define RMTRANSPORT_H_
+#ifndef RM_TRANSPORT_H_
+#define RM_TRANSPORT_H_
#ifdef __cplusplus
extern "C" {
#endif
+/* Standard includes */
+#include <stdbool.h>
+
/* RM includes */
#include <ti/drv/rm/rm.h>
/**
-@addtogroup RMTRANSPORT_API
+@addtogroup RM_TRANSPORT_API
@{
*/
-/** RM Transport Result Return Codes */
-/** RM Transport Success Code Base */
-#define RM_TRANSPORT_OK_BASE (0)
-/** RM transport action was successful. */
-#define RM_TRANSPORT_SUCCESSFUL (RM_TRANSPORT_OK_BASE)
-
-/** RM Transport Error Code Base */
-#define RM_TRANSPORT_ERROR_BASE (-64)
-/** RM transport handle has not been registered with the RM instance */
-#define RM_TRANSPORT_ERROR_HANDLE_HAS_NOT_BEEN_REGISTERED (RM_TRANSPORT_ERROR_BASE-1)
-/** RM packets are available but an error was encountered during reception */
-#define RM_TRANSPORT_ERROR_PACKET_RECEPTION_ERROR (RM_TRANSPORT_ERROR_BASE-3)
-/** RM received a packet with an unknown RM packet type */
-#define RM_TRANSPORT_ERROR_INVALID_PACKET_TYPE (RM_TRANSPORT_ERROR_BASE-4)
-/** RM resource request transaction could not be found matching the response received */
-#define RM_TRANSPORT_ERROR_MATCHING_RESOURCE_REQUEST_NOT_FOUND (RM_TRANSPORT_ERROR_BASE-5)
-/** RM NameServer request transaction could not be found matching the response received */
-#define RM_TRANSPORT_ERROR_MATCHING_NAME_SERVER_REQUEST_NOT_FOUND (RM_TRANSPORT_ERROR_BASE-6)
-
-/**
- * @brief Result of RM transport layer operations
- */
-typedef int32_t Rm_TransportResult;
-
/** Maximum size of the RM transport packet */
-#define RM_TRANSPORT_PACKET_MAX_SIZE_BYTES (256) // Placeholder: This will
- // change during development
+#define RM_TRANSPORT_PACKET_MAX_SIZE_BYTES (256)
/**
* @brief RM transport handle
/** Allocate/Free request packet */
Rm_pktType_RESOURCE_REQUEST = 0,
/** Allocate/Free response packet */
- Rm_pktType_RESOURCE_RESPONSE = 1,
+ Rm_pktType_RESOURCE_RESPONSE,
/** RM NameServer mapping request */
- Rm_pktType_NAMESERVER_REQUEST = 2,
+ Rm_pktType_NAMESERVER_REQUEST,
/** RM NameServer mapping response */
- Rm_pktType_NAMESERVER_RESPONSE = 3,
- /** Policy request packet */
- Rm_pktType_POLICY_REQUEST = 4,
- /** Policy response packet */
- Rm_pktType_POLICY_CHANGE = 5,
- /** Resource pool modification request */
- Rm_pktType_RESOURCE_POOL_MODIFICATION_REQUEST = 6,
- /** Resource pool modification response */
- Rm_pktType_RESOURCE_POOL_MODIFICATION_RESPONSE = 7
+ Rm_pktType_NAMESERVER_RESPONSE
} Rm_pktType;
/**
*/
typedef struct {
/** Packet length in bytes. Written by application when allocated */
- uint32_t pktLenBytes;
+ uint32_t pktLenBytes;
/** Type of RM packet contained in the byte data array */
Rm_pktType pktType;
/** Byte array containing RM packet data */
- char data[RM_TRANSPORT_PACKET_MAX_SIZE_BYTES];
+ char data[RM_TRANSPORT_PACKET_MAX_SIZE_BYTES];
} Rm_Packet;
typedef struct {
* Failure - NULL
*/
Rm_TransportHandle Rm_transportRegister (Rm_TransportCfg *transportCfg, int32_t *result);
-Rm_TransportResult Rm_transportUnregister (Rm_Handle rmHandle, Rm_TransportHandle transportHandle);
+int32_t Rm_transportUnregister (Rm_Handle rmHandle, Rm_TransportHandle transportHandle);
int32_t Rm_receivePktIsr(Rm_TransportHandle transportHandle, Rm_Packet *pkt);
int32_t Rm_receivePktPolling(Rm_TransportHandle transportHandle);
}
#endif
-#endif /* RMTRANSPORT_H_ */
+#endif /* RM_TRANSPORT_H_ */