Initial contribution of loader_communication

ST-Ericsson ID: 326913
ST-Ericsson FOSS-OUT ID: STETL-FOSS-OUT-10204

Change-Id: I171cfc2ee458a8a0a91a1916137d131f0f7ecee5

1 files changed, 65 insertions, 0 deletions

diff --git a/lcmodule/source/cnh1606344_ldr_communication_module/include/r_protrom_family.h b/lcmodule/source/cnh1606344_ldr_communication_module/include/r_protrom_family.h
new file mode 100644
index 0000000..a5498c6
--- /dev/null
+++ b/lcmodule/source/cnh1606344_ldr_communication_module/include/r_protrom_family.h
@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright (C) ST-Ericsson SA 2011
+ * License terms: 3-clause BSD license
+ ******************************************************************************/
+#ifndef _INCLUSION_GUARD_R_PROTROM_FAMILY_H_
+#define _INCLUSION_GUARD_R_PROTROM_FAMILY_H_
+/**
+ *  @addtogroup ldr_communication_module
+ *  @{
+ *    @addtogroup protrom_family Protrom Family
+ *    The PROTROM family include only one protocol PROTROM used for
+ *    communication between the ROM code and PC tool. This module include
+ *    protrom transport layer and protrom network layer for handling protrom
+ *    protocol.
+ *
+ *    @{
+ */
+
+/*******************************************************************************
+ * Includes
+ ******************************************************************************/
+#include "t_protrom_protocol.h"
+#include "error_codes.h"
+#include "t_communication_service.h"
+
+/*******************************************************************************
+ * Declaration of functions
+ ******************************************************************************/
+
+#define PROTROM_TRANSPORT(x) (&((Protrom_FamilyContext_t *) (x)->FamilyContext_p)->Transport)
+#define PROTROM_NETWORK(x) (&((Protrom_FamilyContext_t *) (x)->FamilyContext_p)->Network)
+
+/**
+ * Protrom family protocols initialization.
+ *
+ * @param [in] Communication_p Communication module context.
+ *
+ * @retval  E_SUCCESS                   After successful execution.
+ * @retval  E_INVALID_INPUT_PARAMETERS  Invalid input parameter.
+ */
+ErrorCode_e Protrom_Family_Init(Communication_t *Communication_p);
+
+/**
+ * Protrom family protocols sutdown.
+ *
+ * @param [in] Communication_p Communication module context.
+ *
+ * @retval  E_SUCCESS                   After successful execution.
+ * @retval  E_INVALID_INPUT_PARAMETERS  Invalid input parameter.
+ */
+ErrorCode_e Protrom_Family_Shutdown(Communication_t *Communication_p);
+
+/*
+ * Protrom Cancel Transmition.
+ *
+ * @param [in] Communication_p Communication module context.
+ * @param [in] PacketsBeforeTransferStop Number of packets that will be transmited before stopping the transmition.
+ *
+ * @retval  E_SUCCESS                   After successful execution.
+ * @retval  E_INVALID_INPUT_PARAMETERS  Invalid input parameter.
+ */
+ErrorCode_e Protrom_CancelReceiver(Communication_t *Communication_p, uint8 PacketsBeforeTransferStop);
+/** @} */
+/** @} */
+#endif //_INCLUSION_GUARD_R_PROTROM_FAMILY_H_