summaryrefslogtreecommitdiff
path: root/lcmodule/source/cnh1606344_ldr_communication_module/include
diff options
context:
space:
mode:
authorxmarvla <vlatko.markovic@seavus.com>2011-06-16 14:45:38 +0100
committerViktor Mladenovski <viktor.mladenovski@seavus.com>2011-08-17 22:10:43 +0200
commitb9b4df06ddb81a6d14354fc0d42e22acf0b4c30c (patch)
tree48b17930f3f28c72094f090ba38e6761aa43416b /lcmodule/source/cnh1606344_ldr_communication_module/include
parentc9d1f9613e3ac18d5dd3b9432646e289bb88cec9 (diff)
LCM R1T and LCDriver R1N official release.
ST-Ericsson ID: 345044 ST-Ericsson FOSS-OUT ID: STETL-FOSS-OUT-10204 Change-Id: Ib1901abfc2efa6c887c70b8583ddd2258e21aa78 Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/25187 Tested-by: Vlatko STENKOSKI Tested-by: Cvetko MLADENOVSKI <cvetko.mladenovski@seavus.com> Tested-by: Aleksandar GASOSKI <aleksandar.gasoski@seavus.com> Reviewed-by: Zoran ANCEVSKI <zoran.ancevski@seavus.com> Reviewed-by: QATEST Reviewed-by: Vlatko PISTOLOV <vlatko.pistolov@seavus.com> Conflicts: lcmodule/win_binaries/LCM.dll win_binaries/LCDriver_CNH1606432.dll
Diffstat (limited to 'lcmodule/source/cnh1606344_ldr_communication_module/include')
-rw-r--r--lcmodule/source/cnh1606344_ldr_communication_module/include/r_a2_family.h6
-rw-r--r--lcmodule/source/cnh1606344_ldr_communication_module/include/r_communication_service.h11
-rw-r--r--lcmodule/source/cnh1606344_ldr_communication_module/include/t_communication_service.h25
3 files changed, 25 insertions, 17 deletions
diff --git a/lcmodule/source/cnh1606344_ldr_communication_module/include/r_a2_family.h b/lcmodule/source/cnh1606344_ldr_communication_module/include/r_a2_family.h
index 614aaa9..c5f409b 100644
--- a/lcmodule/source/cnh1606344_ldr_communication_module/include/r_a2_family.h
+++ b/lcmodule/source/cnh1606344_ldr_communication_module/include/r_a2_family.h
@@ -7,7 +7,11 @@
/**
* @addtogroup ldr_communication_serv
* @{
- * @addtogroup a2_family
+ * @addtogroup a2_family A2 protocol family
+ * The A2 family include only one protocol, A2 protocol, used for
+ * communication between the ME and PC tool. This module includes
+ * A2 transport layer and A2 network layer for handling A2 protocol.
+ *
* @{
*/
diff --git a/lcmodule/source/cnh1606344_ldr_communication_module/include/r_communication_service.h b/lcmodule/source/cnh1606344_ldr_communication_module/include/r_communication_service.h
index 75306a9..86e2990 100644
--- a/lcmodule/source/cnh1606344_ldr_communication_module/include/r_communication_service.h
+++ b/lcmodule/source/cnh1606344_ldr_communication_module/include/r_communication_service.h
@@ -57,7 +57,6 @@
extern Communication_t *GlobalCommunication_p;
extern Communication_t DebugCommunication;
-
/*******************************************************************************
* Declaration of functions
******************************************************************************/
@@ -73,13 +72,17 @@ extern "C"
* and communication device descriptor, a new instance of the
* communication module is created and bound to use the provided devices.
*
- * @param [in,out] Communication_p Communication module context.
+ * @param [in] Object_p Instance which will use initialized communication.
+ * @param [in,out] Communication_pp Communication module context.
* @param [in] Family Initial protocol family.
* @param [in] HashDevice_p The device to use for checksum
* calculations and verifications.
- * @param [in] *CommunicationDevice_p The device to use for network
+ * @param [in] CommunicationDevice_p The device to use for network
* transmission.
* @param [in] CommandCallback_p Collback function for command handling.
+ * @param [in] Buffers_p Pointer to buffer handling functions.
+ * @param [in] Timers_p Pointer to timers handling functions.
+ * @param [in] Queue_p Pointer to queue handling functions.
*
* @retval E_SUCCESS If the module instance is successfully
* initialized. A protocol family dependant error
@@ -203,7 +206,7 @@ extern "C"
LCM_API ErrorCode_e Do_Communication_SetCommunicationDevice(Communication_t *Communication_p, CommunicationDevice_t *CommunicationDevice_p);
/*
- * Cancek Receiving new packets
+ * Cancel Receiving new packets
*
* @param [in] Communication_p Communication module context.
* @param [in] PacketsBeforeReceiverStop Number of packets to be send before stopping the receiver.
diff --git a/lcmodule/source/cnh1606344_ldr_communication_module/include/t_communication_service.h b/lcmodule/source/cnh1606344_ldr_communication_module/include/t_communication_service.h
index 3b686cc..74f4721 100644
--- a/lcmodule/source/cnh1606344_ldr_communication_module/include/t_communication_service.h
+++ b/lcmodule/source/cnh1606344_ldr_communication_module/include/t_communication_service.h
@@ -44,7 +44,7 @@ typedef enum {
typedef void (*CommunicationCallback_t)(const void *Data_p, const uint32 Length, void *Param_p);
typedef void (*HashCallback_t)(void *Data_p, const uint32 Length, uint8 *Hash_p, void *Param_p);
-typedef boolean(*DeviceRead_fn)(void *Data_p, uint32 Length, CommunicationCallback_t Callback_fn, void *Param_p);
+typedef ErrorCode_e(*DeviceRead_fn)(void *Data_p, uint32 Length, CommunicationCallback_t Callback_fn, void *Param_p);
typedef ErrorCode_e(*DeviceWrite_fn)(void *Data_p, uint32 Length, CommunicationCallback_t Callback_fn, void *Param_p);
typedef ErrorCode_e(*DeviceCancel_fn)(void *Param_p);
typedef void (*HashDeviceCancel_fn)(void *Object_p, void **Param_p);
@@ -122,8 +122,8 @@ typedef struct {
defined timer. */
ReadTime_t ReadTime_Fn; /**< Pointer to function for read time from
specified timer. */
- GetSystemTime_t GetSystemTime_Fn; /**< Pointer to function for read curent
- sytem time. */
+ GetSystemTime_t GetSystemTime_Fn; /**< Pointer to function for read current
+ system time. */
void *Object_p; /**< Pointer for instancing. It is used in
the PC application, but in the loaders
is always NULL */
@@ -165,7 +165,7 @@ typedef struct {
then all interrupt
enabled. */
RFifoDestroy_t RFifoDestroy_Fn; /**< Pointer to function
- for Fifo destroing.
+ for Fifo destroying.
First all interrupts
are disabled,
function executed and
@@ -219,9 +219,9 @@ typedef struct {
executed and then all
interrupt enabled. */
void *Object_p; /**<Pointer for instancing.
- It is used in the PC
- application, but in the
- loaders is always NULL.*/
+ It is used in the PC
+ application, but in the
+ loaders is always NULL.*/
} QueueInterface_t;
/**
@@ -247,9 +247,10 @@ typedef struct {
communication device. */
DeviceWrite_fn Write; /**< Pointer to function for write data thru the
communication device. */
- DeviceCancel_fn Cancel; /**< Pointer to function for caneling current
- communcation with communiation device. */
+ DeviceCancel_fn Cancel; /**< Pointer to function for canceling current
+ communication with communication device. */
void *Context_p; /**< Pointer to Device description data. */
+ void *Object_p; /**< Pointer to Object associated with the device. */
} CommunicationDevice_t;
/**
@@ -288,7 +289,7 @@ typedef struct ExecutionContext_s {
/** Communication context.*/
typedef struct {
void *Inbound_p; /**< Pointer to structure for
- handling incomming
+ handling incoming
packets.*/
void *Outbound_p; /**< Pointer to structure for
handling outgoing
@@ -309,7 +310,7 @@ typedef struct {
FunctionInterface_t *Functions_p; /**< Pointer to interface
functions for buffers,
timers and queue.*/
- Do_CEH_Call_t Do_CEH_Call_Fn; /**< Pointer to calback
+ Do_CEH_Call_t Do_CEH_Call_Fn; /**< Pointer to callback
function for handling
commands received thru
the LCM.*/
@@ -329,7 +330,7 @@ typedef struct FamilyDescriptor_s {
ErrorCode_e(*FamilyInit_fn)(Communication_t *Communication_p);
/**< Pointer to Interface function for protocol family de-initialization. */
ErrorCode_e(*FamilyShutdown_fn)(Communication_t *Communication_p);
- /**< Pointer to Pooling function in curren protocol family. */
+ /**< Pointer to Pooling function in current protocol family. */
ErrorCode_e(*Process_fn)(Communication_t *Communication_p);
/**< Pointer to function for sending packets.*/
ErrorCode_e(*Send_fn)(Communication_t *Communication_p, void *InputData_p);