diff options
Diffstat (limited to 'lcmodule/source/cnh1605205_ldr_network_layer/include')
11 files changed, 39 insertions, 44 deletions
diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_a2_network.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_a2_network.h index fd6efb7..a4007e5 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_a2_network.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_a2_network.h @@ -58,7 +58,7 @@ ErrorCode_e A2_Network_Shutdown(const Communication_t *const Communication_p); ErrorCode_e A2_Network_CancelRetransmission(const Communication_t *const Communication_p, uint32 UniqueKey); /** - * Handler for received packets in A2 protocl family. + * Handler for received packets in A2 protocol family. * * This callback function handles the received packets. * diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_header.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_header.h index 8165430..1462f12 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_header.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_header.h @@ -19,7 +19,6 @@ * Includes ******************************************************************************/ #include <t_basicdefinitions.h> -#include "t_protrom_header.h" #include "t_protrom_network.h" /******************************************************************************* diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_network.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_network.h index a6e897c..c18108d 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_network.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_protrom_network.h @@ -51,7 +51,7 @@ ErrorCode_e Protrom_Network_Shutdown(const Communication_t *const Communication_ * * @param [in] Data_p Pointer to the received data. * @param [in] Length Length of the received data. - * @param [in] Param_p Extra parameteres. + * @param [in] Param_p Extra parameters. * * @return none. */ diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_r15_network_layer.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_r15_network_layer.h index cf739b5..9a2c53f 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_r15_network_layer.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_r15_network_layer.h @@ -22,7 +22,6 @@ #include "error_codes.h" #include "t_basicdefinitions.h" #include "t_r15_network_layer.h" -#include "t_communication_service.h" /******************************************************************************* * Declaration of functions @@ -66,14 +65,14 @@ ErrorCode_e R15_Network_CancelRetransmission(const Communication_t *const Commun * combination of protocol type, session number and command. * * @param [in] Packet_p Pointer to the packet. - * @param [in] ExternalKey External key for marking the packet for retransmision. + * @param [in] ExternalKey External key for marking the packet for retransmission. * * @return Unique key. */ uint32 R15_Network_CreateUniqueKey(const PacketMeta_t *const Packet_p, const uint8 ExternalKey); /** - * Handler for received packets in R15 protocl family. + * Handler for received packets in R15 protocol family. * * This callback function handles the received packets. * @@ -114,7 +113,7 @@ ErrorCode_e R15_Network_ReceiverHandler(Communication_t *Communication_p); /** * Handler for sending data. * - * This function checks if new data is available for sending and handles the transmision. + * This function checks if new data is available for sending and handles the transmission. * * @param [in,out] Communication_p Communication module context. * diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_z_network.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_z_network.h index c8450e5..892eb6f 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/r_z_network.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/r_z_network.h @@ -49,7 +49,7 @@ ErrorCode_e Z_Network_Initialize(Communication_t *Communication_p); ErrorCode_e Z_Network_Shutdown(const Communication_t *const Communication_p); /** - * Handler for received packets in Z protcol family. + * Handler for received packets in Z protocol family. * * This callback function handles the received packets. * @@ -77,7 +77,7 @@ void Z_Network_ReadCallback(const void *Data_p, const uint32 Length, void *Param void Z_Network_WriteCallback(const void *Data_p, const uint32 Length, void *Param_p); /** - * Handler for receiving new data in Z protcol family. + * Handler for receiving new data in Z protocol family. * * This function checks if new data has been received. * @@ -89,9 +89,9 @@ void Z_Network_ReceiverHandler(Communication_t *Communication_p); /** - * Handler for sending new data in Z protcol family. + * Handler for sending new data in Z protocol family. * - * This function checks if new data has been transmited. + * This function checks if new data has been transmitted. * * @param [in] Communication_p Communication module context. * @param [in] SendingContent_p Pointer to the sending context. diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_header.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_header.h index 63ae6ef..a434e79 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_header.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_header.h @@ -32,8 +32,6 @@ #define PROTROM_HEADER_LENGTH 7 /** Value of the reserved field */ #define PROTROM_RESERVED_FIELD 0x00 -/** Offset of the header in the buffer */ -#define HEADER_OFFSET_IN_BUFFER 8 /** * Header search results @@ -52,7 +50,7 @@ typedef struct { uint8 HeaderPattern; /**< Header pattern for marking header start.*/ uint8 Protocol; /**< Protocol type. */ uint8 SourceAddress; /**< Source address. */ - uint8 DestinationAddress; /**< Destionation address. */ + uint8 DestinationAddress; /**< Destination address. */ uint8 ReservedField; /**< Reserved field. */ uint16 PayloadLength; /**< Payload length. */ } Protrom_Header_t; diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_network.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_network.h index b29a65a..fe693f4 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_network.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_protrom_network.h @@ -39,11 +39,11 @@ typedef enum { /** Defined state of the transmitter */ typedef enum { - PROTROM_SEND_IDLE, /**< Transmiter idle state.*/ - PROTROM_SEND_HEADER, /**< Transmiter send header. */ - PROTROM_SEND_PAYLOAD, /**< Transmiter send payload. */ - PROTROM_SENDING_HEADER, /**< Transmiter is in process sending header.*/ - PROTROM_SENDING_PAYLOAD /**< Transmiter is in process sending payload.*/ + PROTROM_SEND_IDLE, /**< Transmitter idle state.*/ + PROTROM_SEND_HEADER, /**< Transmitter send header. */ + PROTROM_SEND_PAYLOAD, /**< Transmitter send payload. */ + PROTROM_SENDING_HEADER, /**< Transmitter is in process sending header.*/ + PROTROM_SENDING_PAYLOAD /**< Transmitter is in process sending payload.*/ } Protrom_OutboundState_t; /** Structure for the packet meta data type. */ @@ -52,8 +52,8 @@ typedef struct Protrom_Packet { uint8 *Buffer_p; /**< Temporary buffer for receiving data.*/ uint16 CRC; /**< Calculated CRC of received packet. */ Communication_t *Communication_p; /**< The communication over which this - packet has been/is to be transferred - over */ + packet has been/is to be transferred + over */ } Protrom_Packet_t; /** Structure for handling incoming PROTROM packets.*/ @@ -62,9 +62,9 @@ typedef struct { Protrom_InboundState_t State; /**< Number of requested data for receiving from communication device. */ uint32 ReqData; - /**< Number of receivied data from communication device. */ + /**< Number of received data from communication device. */ uint32 RecData; - /**< Number of receivied data from backup buffer used for switching the + /**< Number of received data from backup buffer used for switching the * protocol family. */ uint32 RecBackupData; /**< Offset in the buffer for next data that should be received. */ @@ -73,7 +73,7 @@ typedef struct { uint8 *Target_p; /**< Temporary buffer for receiving data. */ uint8 Scratch[PROTROM_HEADER_LENGTH]; - /** Number of packets before receiver is stoped. */ + /** Number of packets before receiver is stopped. */ uint8 PacketsBeforeReceiverStop; /** Indicator for stopping the receiver. */ boolean StopTransfer; diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_header.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_header.h index e31ca8c..4b5cc70 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_header.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_header.h @@ -69,7 +69,7 @@ typedef struct { uint8 HeaderPattern; /**< Header pattern for marking header start.*/ uint8 Protocol; /**< Protocol type. */ uint16 HeaderPatternExtension; /**< Header pattern extension.*/ - uint8 Flags; /**< Flasgs for the header.*/ + uint8 Flags; /**< Flags for the header.*/ uint8 ExtendedHeaderLength; /**< Extended header length.*/ uint8 ExtendedHeaderChecksum; /**< Extended header checksum.*/ uint32 PayloadLength; /**< Payload length. */ diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_network_layer.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_network_layer.h index 0bd2944..408fdf9 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_network_layer.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_r15_network_layer.h @@ -71,8 +71,8 @@ /** Size of a buffer used for commands. */ #define COMMAND_BUFFER_SIZE 0x00010000 -/** Size of a buffer used for bulk transfer, - * must be biger than buffer for commands. */ +/** Size of a payload buffer used for bulk transfer, + * must be larger than buffer for commands. */ #define BULK_BUFFER_SIZE 0x00100000 @@ -86,7 +86,7 @@ #define SESSION_MASK 0xFFFC /** - * Defines all posible types of buffers that can be created (allocated). + * Defines all possible types of buffers that can be created (allocated). * * It is used to specified the type of the buffer * when allocating a new buffer. Also it is used when @@ -108,7 +108,7 @@ TYPEDEF_ENUM { BUF_TX_SENT = 0x00000008, /**< The buffer is sent and wait ACK. */ BUF_TX_DONE = 0x00000010, /**< The buffer has been sent and can be deallocated. */ - BUF_TX_TIMEOUT = 0x00000020, /**< The timeout ocure when buffer is + BUF_TX_TIMEOUT = 0x00000020, /**< The timeout occur when buffer is sending. */ BUF_RX_READY = 0x00000040, /**< The buffer is filled with received data and is ready for @@ -201,7 +201,7 @@ typedef void (*PacketCallBack_t)(Communication_t *Communication_p, const void *D /** Structure for the packet meta data. */ typedef struct PacketMeta { - PacketCallBack_t CallBack_p; /**< Cllback function used after + PacketCallBack_t CallBack_p; /**< Callback function used after sending packet.*/ uint32 Flags; /**< Field is a bit-field. Flags for the Packet state. */ @@ -209,9 +209,9 @@ typedef struct PacketMeta { corresponding buffer used in the packet. */ R15_Header_t Header; /**< Structure of the header. */ - uint32 Resend; /**< Resend counter. */ + uint32 Resend; /**< Resent counter. */ Timer_t *Timer_p; /**< Timer data used for - sending/reciving packet. */ + sending/receiving packet. */ uint8 *ExtendedHeader_p; /**< Pointer to the extended header located in the packet. */ uint8 *Payload_p; /**< Pointer to the payload data @@ -234,8 +234,7 @@ typedef struct { uint32 Timeout; /**< Defined timeout for retransmission. */ uint32 TimerKey; /**< Timer identification number.*/ uint32 Key; /**< Generated unique key, used for marking packet for - retransmission or removing from - retransmission list. */ + retransmission or removing from retransmission list. */ PacketMeta_t *Packet_p; /**< Pointer to the packet for retransmission. */ } RetransmissionContext_t; @@ -246,9 +245,9 @@ typedef struct { R15_InboundState_t State; /**< Number of requested data for receiving from communication device. */ uint32 ReqData; - /**< Number of receivied data from communication device. */ + /**< Number of received data from communication device. */ uint32 RecData; - /**< Number of receivied data from backup buffer used for switching the + /**< Number of received data from backup buffer used for switching the * protocol family. */ uint32 RecBackupData; /**< Offset in the buffer for next data that should be received. */ @@ -259,9 +258,9 @@ typedef struct { uint8 Scratch[ALIGNED_HEADER_LENGTH + ALIGNED_BULK_EXTENDED_HEADER_LENGTH]; /** Temporary structure for handling R15 packet.*/ R15_Header_t Header; - /** Poiter to meta data for allocated buffer for handling R15 packet.*/ + /** Pointer to meta data for allocated buffer for handling R15 packet.*/ PacketMeta_t *Packet_p; - /** Number of packets before receiver is stoped. */ + /** Number of packets before receiver is stopped. */ uint8 PacketsBeforeReceiverStop; /** Indicator for stopping the receiver. */ boolean StopTransfer; diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_header.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_header.h index 09fe771..0eab5d2 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_header.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_header.h @@ -10,7 +10,7 @@ * @addtogroup z_family * @{ * @addtogroup ldr_z_header Z header - * Functionalities for analizing header from Z protocol family. + * Functionalities for analyzing header from Z protocol family. * * @{ */ diff --git a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_network.h b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_network.h index 7f66e67..fa189f1 100644 --- a/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_network.h +++ b/lcmodule/source/cnh1605205_ldr_network_layer/include/t_z_network.h @@ -34,9 +34,9 @@ typedef enum { /** Defined state of the transmitter */ typedef enum { - Z_SEND_IDLE, /**< Transmiter idle state.*/ - Z_SEND_PACKET, /**< Transmiter send packet. */ - Z_SENDING_PACKET /**< Transmiter is in process sending packet.*/ + Z_SEND_IDLE, /**< Transmitter idle state.*/ + Z_SEND_PACKET, /**< Transmitter send packet. */ + Z_SENDING_PACKET /**< Transmitter is in process sending packet.*/ } Z_OutboundState_t; /** Structure for handling incoming Z packets.*/ @@ -45,11 +45,11 @@ typedef struct { Z_InboundState_t State; /**< Number of requested data for receiving from communication device. */ uint32 ReqData; - /**< Number of receivied data from communication device. */ + /**< Number of received data from communication device. */ uint32 RecData; /**< Temporary pointer to buffer for handling received data.*/ uint8 *Target_p; - /** Number of packets before receiver is stoped. */ + /** Number of packets before receiver is stopped. */ uint8 PacketsBeforeReceiverStop; /** Indicator for stopping the receiver. */ boolean StopTransfer; |