ifx-record-handover-select.h File Reference

Model interface to create the handover select record types and set/get record fields. More...

#include <stddef.h>
#include <stdint.h>
#include "infineon/ifx-error.h"
#include "infineon/ifx-utils.h"

Go to the source code of this file.

Data Structures
struct	ifx_local_record_handles_t
	This Structure holds the list of alternate carrier record handles and a single error record, which is recognised as handover select's local records. More...

Macros
#define	IFX_RECORD_HS_SET   UINT8_C(0x01)
	Identifier for model set handover select record ID.
#define	IFX_RECORD_HS_GET   UINT8_C(0x02)
	Identifier for model get handover select record ID.
#define	IFX_RECORD_HS_RELEASE_MEMORY   UINT8_C(0x03)
	Identifier for model handover select record release memory.
#define	IFX_RECORD_HS_TYPE   {0x48, 0x73}
	Type information for URI record 'Hs'.

Functions
ifx_status_t	ifx_record_hs_new (ifx_record_handle_t *handle)
	Creates a new handover select record and handle of the created record. This handle holds the values of the record needed for encode and decode operations.
ifx_status_t	ifx_record_hs_set_major_ver (ifx_record_handle_t *handle, uint8_t major_version)
	Sets the major version in the handover select record details for the given record handle.
ifx_status_t	ifx_record_hs_set_minor_ver (ifx_record_handle_t *handle, uint8_t minor_version)
	Sets the minor version in handover select record details for the given record handle.
ifx_status_t	ifx_record_hs_set_local_records (ifx_record_handle_t *handle, const ifx_local_record_handles_t *local_record_list, uint32_t count_of_local_records)
	Sets the list of local records (alternative carrier and error records) to the handover select record for the given record handle.
ifx_status_t	ifx_record_hs_get_major_ver (const ifx_record_handle_t *handle, uint8_t *major_version)
	Gets the major version of the handover select record from the given record handle.
ifx_status_t	ifx_record_hs_get_minor_ver (const ifx_record_handle_t *handle, uint8_t *minor_version)
	Gets the minor version of handover select record from the given record handle.
ifx_status_t	ifx_record_hs_get_local_records (const ifx_record_handle_t *handle, ifx_local_record_handles_t *local_record_list, uint32_t *count_of_local_records)
	Gets the list of local records from the given record handle.

Detailed Description

Model interface to create the handover select record types and set/get record fields.

Definition in file ifx-record-handover-select.h.

Macro Definition Documentation

IFX_RECORD_HS_GET

#define IFX_RECORD_HS_GET   UINT8_C(0x02)

Identifier for model get handover select record ID.

Definition at line 32 of file ifx-record-handover-select.h.

IFX_RECORD_HS_RELEASE_MEMORY

#define IFX_RECORD_HS_RELEASE_MEMORY   UINT8_C(0x03)

Identifier for model handover select record release memory.

Definition at line 37 of file ifx-record-handover-select.h.

IFX_RECORD_HS_SET

#define IFX_RECORD_HS_SET   UINT8_C(0x01)

Identifier for model set handover select record ID.

Definition at line 27 of file ifx-record-handover-select.h.

IFX_RECORD_HS_TYPE

#define IFX_RECORD_HS_TYPE   {0x48, 0x73}

Type information for URI record 'Hs'.

Definition at line 41 of file ifx-record-handover-select.h.

Function Documentation

ifx_record_hs_get_local_records()

ifx_status_t ifx_record_hs_get_local_records	(	const ifx_record_handle_t *	handle,
		ifx_local_record_handles_t *	local_record_list,
		uint32_t *	count_of_local_records )

Gets the list of local records from the given record handle.

Parameters

[in]	handle	Pointer to the record handle obtained while creating the record.
[out]	local_record_list	Pointer to the list of local records such as alternative carrier, error records.
[out]	count_of_local_records	Number of the local records.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the get operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_RECORD_INVALID	If record type is invalid
IFX_OUT_OF_MEMORY	If memory allocation is invalid

ifx_record_hs_get_major_ver()

ifx_status_t ifx_record_hs_get_major_ver	(	const ifx_record_handle_t *	handle,
		uint8_t *	major_version )

Gets the major version of the handover select record from the given record handle.

Parameters

[in]	handle	Pointer to the record handle obtained while creating the record.
[out]	major_version	Major version field of the handover select record.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the get operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_RECORD_INVALID	If record type is invalid

ifx_record_hs_get_minor_ver()

ifx_status_t ifx_record_hs_get_minor_ver	(	const ifx_record_handle_t *	handle,
		uint8_t *	minor_version )

Gets the minor version of handover select record from the given record handle.

Parameters

[in]	handle	Pointer to the record handle obtained while creating the record.
[out]	minor_version	Minor version field of the handover select record.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the get operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_RECORD_INVALID	If record type is invalid

ifx_record_hs_new()

ifx_status_t ifx_record_hs_new

(

ifx_record_handle_t *

handle

)

Creates a new handover select record and handle of the created record. This handle holds the values of the record needed for encode and decode operations.

Parameters

[out]

handle

Handle of the created select record.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the record creation operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_OUT_OF_MEMORY	If memory allocation is invalid

ifx_record_hs_set_local_records()

ifx_status_t ifx_record_hs_set_local_records	(	ifx_record_handle_t *	handle,
		const ifx_local_record_handles_t *	local_record_list,
		uint32_t	count_of_local_records )

Sets the list of local records (alternative carrier and error records) to the handover select record for the given record handle.

Parameters

[out]	handle	Pointer to the record handle obtained while creating the record.
[in]	local_record_list	Pointer to the list of local records such as alternative carrier, error records.
[in]	count_of_local_records	Number of the local records.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the set operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_RECORD_INVALID	If record type is invalid
IFX_OUT_OF_MEMORY	If memory allocation is invalid

ifx_record_hs_set_major_ver()

ifx_status_t ifx_record_hs_set_major_ver	(	ifx_record_handle_t *	handle,
		uint8_t	major_version )

Sets the major version in the handover select record details for the given record handle.

Parameters

[out]	handle	Pointer to the record handle obtained while creating the record.
[in]	major_version	Major version field of the handover select record.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the set operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_RECORD_INVALID	If record type is invalid

ifx_record_hs_set_minor_ver()

ifx_status_t ifx_record_hs_set_minor_ver	(	ifx_record_handle_t *	handle,
		uint8_t	minor_version )

Sets the minor version in handover select record details for the given record handle.

Parameters

[out]	handle	Pointer to the record handle obtained while creating the record.
[in]	minor_version	Minor version field of the handover select record.

Returns

ifx_status_t

Return values

IFX_SUCCESS	If the set operation is successful
IFX_ILLEGAL_ARGUMENT	If invalid/NULL parameter is passed to function
IFX_RECORD_INVALID	If record type is invalid