Helper functions regarding the TS 08.08 / 48.008 A interface. More...

Macros
#define	BSSMAP_MSG_SIZE 512

#define	BSSMAP_MSG_HEADROOM 128

Functions
struct msgb *	gsm0808_create_layer3_aoip (const struct msgb msg_l3, uint16_t nc, uint16_t cc, int lac, uint16_t _ci, const struct gsm0808_speech_codec_list scl)
	Create "Complete L3 Info" for AoIP. More...

struct msgb *	gsm0808_create_layer3 (struct msgb *msg_l3, uint16_t nc, uint16_t cc, int lac, uint16_t _ci)
	Create "Complete L3 Info" for A. More...

struct msgb *	gsm0808_create_reset (void)
	Create BSSMAP RESET message. More...

struct msgb *	gsm0808_create_reset_ack (void)
	Create BSSMAP RESET ACK message. More...

struct msgb *	gsm0808_create_clear_complete (void)
	Create BSSMAP Clear Complete message. More...

struct msgb *	gsm0808_create_clear_command (uint8_t reason)
	Create BSSMAP Clear Command message. More...

struct msgb *	gsm0808_create_cipher (const struct gsm0808_encrypt_info ei, const uint8_t cipher_response_mode)
	Create BSSMAP Cipher Mode Command message. More...

struct msgb *	gsm0808_create_cipher_complete (struct msgb *layer3, uint8_t alg_id)
	Create BSSMAP Cipher Mode Complete message. More...

struct msgb *	gsm0808_create_cipher_reject (uint8_t cause)
	Create BSSMAP Cipher Mode Reject message. More...

struct msgb *	gsm0808_create_classmark_update (const uint8_t cm2, uint8_t cm2_len, const uint8_t cm3, uint8_t cm3_len)
	Create BSSMAP Classmark Update message. More...

struct msgb *	gsm0808_create_sapi_reject (uint8_t link_id)
	Create BSSMAP SAPI N Reject message. More...

struct msgb *	gsm0808_create_ass (const struct gsm0808_channel_type ct, const uint16_t cic, const struct sockaddr_storage ss, const struct gsm0808_speech_codec_list scl, const uint32_t *ci)
	Create BSSMAP Assignment Request message. More...

struct msgb *	gsm0808_create_ass_compl (uint8_t rr_cause, uint8_t chosen_channel, uint8_t encr_alg_id, uint8_t speech_mode, const struct sockaddr_storage ss, const struct gsm0808_speech_codec sc, const struct gsm0808_speech_codec_list *scl)
	Create BSSMAP Assignment Completed message. More...

struct msgb *	gsm0808_create_assignment_completed (uint8_t rr_cause, uint8_t chosen_channel, uint8_t encr_alg_id, uint8_t speech_mode)
	Create BSSMAP Assignment Completed message. More...

struct msgb *	gsm0808_create_ass_fail (uint8_t cause, const uint8_t rr_cause, const struct gsm0808_speech_codec_list scl)
	Create BSSMAP Assignment Failure message. More...

struct msgb *	gsm0808_create_assignment_failure (uint8_t cause, uint8_t *rr_cause)
	Create BSSMAP Assignment Failure message. More...

struct msgb *	gsm0808_create_clear_rqst (uint8_t cause)
	Create BSSMAP Clear Request message. More...

struct msgb *	gsm0808_create_paging (const char imsi, const uint32_t tmsi, const struct gsm0808_cell_id_list cil, const uint8_t chan_needed)
	Create BSSMAP PAGING message. More...

void	gsm0808_prepend_dtap_header (struct msgb *msg, uint8_t link_id)
	Prepend a DTAP header to given Message Buffer. More...

struct msgb *	gsm0808_create_dtap (struct msgb *msg_l3, uint8_t link_id)
	Create BSSMAP DTAP message. More...

const struct tlv_definition *	gsm0808_att_tlvdef (void)

const char *	gsm0808_bssmap_name (uint8_t msg_type)
	Return string name of BSSMAP Message Type. More...

const char *	gsm0808_bssap_name (uint8_t msg_type)
	Return string name of BSSAP Message Type. More...

Variables
static const struct tlv_definition	bss_att_tlvdef

static const struct value_string	gsm0808_msgt_names []

static const struct value_string	gsm0808_bssap_names []

Detailed Description

Helper functions regarding the TS 08.08 / 48.008 A interface.

Macro Definition Documentation

#define BSSMAP_MSG_HEADROOM 128

Referenced by gsm0808_create_ass(), gsm0808_create_ass_compl(), gsm0808_create_ass_fail(), gsm0808_create_cipher(), gsm0808_create_cipher_complete(), gsm0808_create_cipher_reject(), gsm0808_create_classmark_update(), gsm0808_create_clear_command(), gsm0808_create_clear_complete(), gsm0808_create_clear_rqst(), gsm0808_create_dtap(), gsm0808_create_layer3_aoip(), gsm0808_create_paging(), gsm0808_create_reset(), gsm0808_create_reset_ack(), and gsm0808_create_sapi_reject().

#define BSSMAP_MSG_SIZE 512

Referenced by gsm0808_create_ass(), gsm0808_create_ass_compl(), gsm0808_create_ass_fail(), gsm0808_create_cipher(), gsm0808_create_cipher_complete(), gsm0808_create_cipher_reject(), gsm0808_create_classmark_update(), gsm0808_create_clear_command(), gsm0808_create_clear_complete(), gsm0808_create_clear_rqst(), gsm0808_create_dtap(), gsm0808_create_layer3_aoip(), gsm0808_create_paging(), gsm0808_create_reset(), gsm0808_create_reset_ack(), and gsm0808_create_sapi_reject().

Function Documentation

const struct tlv_definition* gsm0808_att_tlvdef ( void )

References bss_att_tlvdef.

const char* gsm0808_bssap_name ( uint8_t msg_type )

Return string name of BSSAP Message Type.

References get_value_string().

const char* gsm0808_bssmap_name ( uint8_t msg_type )

Return string name of BSSMAP Message Type.

References get_value_string().

struct msgb* gsm0808_create_ass	(	const struct gsm0808_channel_type *	ct,
		const uint16_t *	cic,
		const struct sockaddr_storage *	ss,
		const struct gsm0808_speech_codec_list *	scl,
		const uint32_t *	ci
	)

Create BSSMAP Assignment Request message.

Parameters

[in]	ct	Channel Type
[in]	cic	Circuit Identity Code (Classic A only)
[in]	ss	Socket Address of MSC-side RTP socket (AoIP only)
[in]	scl	Speech Codec List (AoIP only)
[in]	ci	Call Identifier (Optional, LCLS)

Returns: callee-allocated msgb with BSSMAP Assignment Request message

References BSS_MAP_MSG_ASSIGMENT_RQST, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, gsm0808_enc_aoip_trasp_addr(), gsm0808_enc_channel_type(), gsm0808_enc_speech_codec_list(), GSM0808_IE_CALL_ID, GSM0808_IE_CIRCUIT_IDENTITY_CODE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tv_fixed_put(), msgb_tv_push(), msgb_v_put(), OSMO_ASSERT, osmo_htonl, and osmo_htons.

struct msgb* gsm0808_create_ass_compl	(	uint8_t	rr_cause,
		uint8_t	chosen_channel,
		uint8_t	encr_alg_id,
		uint8_t	speech_mode,
		const struct sockaddr_storage *	ss,
		const struct gsm0808_speech_codec *	sc,
		const struct gsm0808_speech_codec_list *	scl
	)

Create BSSMAP Assignment Completed message.

Parameters

[in]	rr_cause	GSM 04.08 RR Cause value
[in]	chosen_channel	Chosen Channel
[in]	encr_alg_id	Encryption Algorithm ID
[in]	speech_mode	Speech Mode
[in]	ss	Socket Address of BSS-side RTP socket
[in]	sc	Speech Codec (current)
[in]	scl	Speech Codec List (permitted)

Returns: callee-allocated msgb with BSSMAP Assignment Complete message

References BSS_MAP_MSG_ASSIGMENT_COMPLETE, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, gsm0808_enc_aoip_trasp_addr(), gsm0808_enc_speech_codec(), gsm0808_enc_speech_codec_list(), GSM0808_IE_CHOSEN_CHANNEL, GSM0808_IE_CHOSEN_ENCR_ALG, GSM0808_IE_RR_CAUSE, GSM0808_IE_SPEECH_VERSION, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tv_push(), msgb_tv_put(), and msgb_v_put().

Referenced by gsm0808_create_assignment_completed().

struct msgb* gsm0808_create_ass_fail	(	uint8_t	cause,
		const uint8_t *	rr_cause,
		const struct gsm0808_speech_codec_list *	scl
	)

Create BSSMAP Assignment Failure message.

Parameters

[in]	cause	BSSMAP Cause value
[in]	rr_cause	GSM 04.08 RR Cause value
[in]	scl	Optional Speech Cdec List (AoIP)

Returns: callee-allocated msgb with BSSMAP Assignment Failure message

References BSS_MAP_MSG_ASSIGMENT_FAILURE, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, gsm0808_enc_speech_codec_list(), GSM0808_IE_CAUSE, GSM0808_IE_RR_CAUSE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), msgb_tv_put(), and msgb_v_put().

Referenced by gsm0808_create_assignment_failure().

struct msgb* gsm0808_create_assignment_completed	(	uint8_t	rr_cause,
		uint8_t	chosen_channel,
		uint8_t	encr_alg_id,
		uint8_t	speech_mode
	)

Create BSSMAP Assignment Completed message.

Parameters

[in]	rr_cause	GSM 04.08 RR Cause value
[in]	chosen_channel	Chosen Channel
[in]	encr_alg_id	Encryption Algorithm ID
[in]	speech_mode	Speech Mode

Returns: callee-allocated msgb with BSSMAP Assignment Complete message

References gsm0808_create_ass_compl().

struct msgb* gsm0808_create_assignment_failure	(	uint8_t	cause,
		uint8_t *	rr_cause
	)

Create BSSMAP Assignment Failure message.

Parameters

[in]	cause	BSSMAP Cause value
[in]	rr_cause	GSM 04.08 RR Cause value

Returns: callee-allocated msgb with BSSMAP Assignment Failure message

References gsm0808_create_ass_fail().

struct msgb* gsm0808_create_cipher	(	const struct gsm0808_encrypt_info *	ei,
		const uint8_t *	cipher_response_mode
	)

Create BSSMAP Cipher Mode Command message.

Parameters

[in]	ei	Mandatory Encryption Information
[in]	cipher_response_mode	optional 1-byte Cipher Response Mode

Returns: callee-allocated msgb with BSSMAP Cipher Mode Command message

References BSS_MAP_MSG_CIPHER_MODE_CMD, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, gsm0808_enc_encrypt_info(), GSM0808_IE_CIPHER_RESPONSE_MODE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tv_push(), msgb_tv_put(), msgb_v_put(), and OSMO_ASSERT.

struct msgb* gsm0808_create_cipher_complete	(	struct msgb *	layer3,
		uint8_t	alg_id
	)

Create BSSMAP Cipher Mode Complete message.

Parameters

[in]	layer3	L3 Message to be included
[in]	alg_id	Chosen Encrpytion Algorithm

Returns: callee-allocated msgb with BSSMAP Cipher Mode Complete message

References BSS_MAP_MSG_CIPHER_MODE_COMPLETE, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, GSM0808_IE_CHOSEN_ENCR_ALG, GSM0808_IE_LAYER_3_MESSAGE_CONTENTS, msgb::l3h, msgb::l4h, msgb_alloc_headroom(), msgb_l3len(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), msgb_tv_put(), and msgb_v_put().

struct msgb* gsm0808_create_cipher_reject ( uint8_t cause )

Create BSSMAP Cipher Mode Reject message.

Parameters

[in] reason TS 08.08 cause value

Returns: callee-allocated msgb with BSSMAP Cipher Mode Reject message

References BSS_MAP_MSG_CIPHER_MODE_REJECT, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tv_push(), and msgb_tv_put().

struct msgb* gsm0808_create_classmark_update	(	const uint8_t *	cm2,
		uint8_t	cm2_len,
		const uint8_t *	cm3,
		uint8_t	cm3_len
	)

Create BSSMAP Classmark Update message.

Parameters

[in]	cm2	Classmark 2
[in]	cm2_len	length (in octets) of cm2
[in]	cm3	Classmark 3
[in]	cm3_len	length (in octets) of cm3

Returns: callee-allocated msgb with BSSMAP Classmark Update message

References BSS_MAP_MSG_CLASSMARK_UPDATE, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, GSM0808_IE_CLASSMARK_INFORMATION_T2, GSM0808_IE_CLASSMARK_INFORMATION_T3, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), and msgb_v_put().

struct msgb* gsm0808_create_clear_command ( uint8_t reason )

Create BSSMAP Clear Command message.

Parameters

[in] reason TS 08.08 cause value

Returns: callee-allocated msgb with BSSMAP Clear Command message

References BSS_MAP_MSG_CLEAR_CMD, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, GSM0808_IE_CAUSE, msgb::l3h, msgb_alloc_headroom(), msgb_tlv_put(), msgb_tv_put(), and msgb_v_put().

struct msgb* gsm0808_create_clear_complete ( void )

Create BSSMAP Clear Complete message.

Returns: callee-allocated msgb with BSSMAP Clear Complete message

References BSS_MAP_MSG_CLEAR_COMPLETE, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, msgb::data, msgb::l3h, msgb_alloc_headroom(), and msgb_tlv_put().

struct msgb* gsm0808_create_clear_rqst ( uint8_t cause )

Create BSSMAP Clear Request message.

Parameters

[in] cause BSSMAP Cause value

Returns: callee-allocated msgb with BSSMAP Clear Request message

References BSS_MAP_MSG_CLEAR_RQST, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, GSM0808_IE_CAUSE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), and msgb_v_put().

struct msgb* gsm0808_create_dtap	(	struct msgb *	msg_l3,
		uint8_t	link_id
	)

Create BSSMAP DTAP message.

Parameters

[in]	msg_l3	Messge Buffer containing Layer3 message
[in]	link_id	Link Identifier

Returns: callee-allocated msgb with BSSMAP DTAP message

References BSSAP_MSG_DTAP, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, msgb::data, header, msgb::l3h, dtap_header::length, dtap_header::link_id, msgb_alloc_headroom(), msgb_l3len(), msgb_put(), and dtap_header::type.

struct msgb* gsm0808_create_layer3	(	struct msgb *	msg_l3,
		uint16_t	nc,
		uint16_t	cc,
		int	lac,
		uint16_t	_ci
	)

Create "Complete L3 Info" for A.

Parameters

[in]	msg_l3	msgb containing Layer 3 Message
[in]	nc	Mobile Network Code
[in]	cc	Mobile Country Code
[in]	lac	Location Area Code
[in]	_ci	Cell Identity

Returns: callee-allocated msgb with Complete L3 Info message

References gsm0808_create_layer3_aoip().

struct msgb* gsm0808_create_layer3_aoip	(	const struct msgb *	msg_l3,
		uint16_t	nc,
		uint16_t	cc,
		int	lac,
		uint16_t	_ci,
		const struct gsm0808_speech_codec_list *	scl
	)

Create "Complete L3 Info" for AoIP.

Parameters

[in]	msg_l3	msgb containing Layer 3 Message
[in]	nc	Mobile Network Code
[in]	cc	Mobile Country Code
[in]	lac	Location Area Code
[in]	_ci	Cell Identity
[in]	scl	Speech Codec List

Returns: callee-allocated msgb with Complete L3 Info message

References __attribute__, BSS_MAP_MSG_COMPLETE_LAYER_3, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, CELL_IDENT_WHOLE_GLOBAL, gsm0808_enc_speech_codec_list(), GSM0808_IE_CELL_IDENTIFIER, GSM0808_IE_LAYER_3_INFORMATION, gsm48_generate_lai(), msgb::l3h, msgb_alloc_headroom(), msgb_l3len(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), msgb_v_put(), and osmo_htons.

Referenced by gsm0808_create_layer3().

struct msgb* gsm0808_create_paging	(	const char *	imsi,
		const uint32_t *	tmsi,
		const struct gsm0808_cell_id_list *	cil,
		const uint8_t *	chan_needed
	)

Create BSSMAP PAGING message.

Parameters

[in]	imsi	Mandatory paged IMSI in string representation
[in]	tmsi	Optional paged TMSI
[in]	cil	Cell Identity List (where to page)
[in]	chan_needed	Channel Type needed

Returns: callee-allocated msgb with BSSMAP PAGING message

References BSS_MAP_MSG_PAGING, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, gsm0808_enc_cell_id_list(), GSM0808_IE_CHANNEL_NEEDED, GSM0808_IE_IMSI, GSM0808_IE_TMSI, gsm48_generate_mid_from_imsi(), GSM48_MI_SIZE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), msgb_tv_put(), msgb_v_put(), OSMO_ASSERT, and osmo_htonl.

struct msgb* gsm0808_create_reset ( void )

Create BSSMAP RESET message.

Returns: callee-allocated msgb with BSSMAP Reset message

References BSS_MAP_MSG_RESET, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, cause, GSM0808_CAUSE_EQUIPMENT_FAILURE, GSM0808_IE_CAUSE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tlv_put(), msgb_tv_push(), and msgb_v_put().

struct msgb* gsm0808_create_reset_ack ( void )

Create BSSMAP RESET ACK message.

Returns: callee-allocated msgb with BSSMAP Reset ACK message

References BSS_MAP_MSG_RESET_ACKNOWLEDGE, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tv_push(), and msgb_v_put().

struct msgb* gsm0808_create_sapi_reject ( uint8_t link_id )

Create BSSMAP SAPI N Reject message.

Parameters

[in] link_id Link Identifier

Returns: callee-allocated msgb with BSSMAP SAPI N Reject message

References BSS_MAP_MSG_SAPI_N_REJECT, BSSAP_MSG_BSS_MANAGEMENT, BSSMAP_MSG_HEADROOM, BSSMAP_MSG_SIZE, GSM0808_CAUSE_BSS_NOT_EQUIPPED, msgb::l3h, msgb_alloc_headroom(), msgb_length(), msgb_tv_push(), and msgb_v_put().

void gsm0808_prepend_dtap_header	(	struct msgb *	msg,
		uint8_t	link_id
	)

Prepend a DTAP header to given Message Buffer.

Parameters

[in]	msgb	Message Buffer
[in]	link_id	Link Identifier

References BSSAP_MSG_DTAP, msgb::len, link_id, and msgb_push().

Variable Documentation

const struct tlv_definition bss_att_tlvdef

static

Referenced by gsm0808_att_tlvdef().

const struct value_string gsm0808_bssap_names[]

static

Initial value:

= {
        { BSSAP_MSG_BSS_MANAGEMENT,             "MANAGEMENT" },
        { BSSAP_MSG_DTAP,                       "DTAP" },
        { 0, NULL }
}

const struct value_string gsm0808_msgt_names[]

static

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

Function Documentation

Variable Documentation