blob: 8165430c56565696e08b56335bfb9f29d58876b4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*******************************************************************************
* Copyright (C) ST-Ericsson SA 2011
* License terms: 3-clause BSD license
******************************************************************************/
#ifndef R_PROTROM_HEADER_H_
#define R_PROTROM_HEADER_H_
/**
* @addtogroup ldr_communication_serv
* @{
* @addtogroup protrom_family
* @{
* @addtogroup ldr_protrom_header PROTROM header
* Functionalities for serialization and de-serialization PROTROM header.
*
* @{
*/
/*******************************************************************************
* Includes
******************************************************************************/
#include <t_basicdefinitions.h>
#include "t_protrom_header.h"
#include "t_protrom_network.h"
/*******************************************************************************
* Declaration of functions
******************************************************************************/
/**
* Get packet length in bytes given the information in Header_p.
*
* @param [in] Header_p Pointer to the header structure.
*
* @return The length of the packet in bytes.
*/
uint32 Protrom_GetPacketLength(const Protrom_Header_t *Header_p);
/**
* Converts the header stored in network format to a structure.
*
* @param [out] Header_p Pointer to the header structure where the
* header data should be placed.
* @param [in] Data_p Pointer to the buffer with received header.
*
* @return none.
*/
void Protrom_DeserializeHeader(Protrom_Header_t *Header_p, void *Data_p);
/**
* Converts the header structure to network format.
*
* The data buffer must be of at least size PROTROM_HEADER_LENGTH.
*
* @param [out] Data_p Pointer to the buffer where the
* serialized header should be placed.
* @param [in] Header_p Pointer to the source header structure.
*
* @return none.
*/
void Protrom_SerializeHeader(void *Data_p, const Protrom_Header_t *Header_p);
/**
* Determines whether the first PROTROM_HEADER_LENGTH bytes of Data_p contains a
* valid header.
*
* @param [in] Data_p Pointer to the header candidate.
*
* @retval TRUE If header is valid.
* @retval FALSE If header is not valid.
*/
boolean Protrom_IsValidHeader(const void *Data_p);
/**
* Checks if new header is received.
*
* @param [in] In_p Pointer to the structure with receiver information.
*
* @retval TRUE If header is received.
* @retval FALSE If header is not received.
*/
boolean Protrom_IsReceivedHeader(Protrom_Inbound_t *In_p);
/** @} */
/** @} */
/** @} */
#endif /*R_PROTROM_HEADER_H_*/
|
