aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmocom/bsc/bsc_api.h
blob: 01f90b1587538510c6cb40e6aa422f2e5074e05a (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
/* GSM 08.08 like API for OpenBSC */

#ifndef OPENBSC_BSC_API_H
#define OPENBSC_BSC_API_H

#include "gsm_data.h"

#define BSC_API_CONN_POL_ACCEPT	0
#define BSC_API_CONN_POL_REJECT	1

struct bsc_api {
	/*! \brief BTS->MSC: tell MSC a SAPI was not established */
	void (*sapi_n_reject)(struct gsm_subscriber_connection *conn, int dlci);
	/*! \brief MS->MSC: Tell MSC that ciphering has been enabled */
	void (*cipher_mode_compl)(struct gsm_subscriber_connection *conn,
				  struct msgb *msg, uint8_t chosen_encr);
	/*! \brief MS->MSC: New MM context with L3 payload */
	int (*compl_l3)(struct gsm_subscriber_connection *conn,
			struct msgb *msg, uint16_t chosen_channel); 
	/*! \brief MS->BSC/MSC: Um L3 message */
	void (*dtap)(struct gsm_subscriber_connection *conn, uint8_t link_id,
			struct msgb *msg);
	/*! \brief BSC->MSC: Assignment of lchan successful */
	void (*assign_compl)(struct gsm_subscriber_connection *conn,
			  uint8_t rr_cause, uint8_t chosen_channel,
			  uint8_t encr_alg_id, uint8_t speech_mode);
	/*! \brief BSC->MSC: Assignment of lchan failed */
	void (*assign_fail)(struct gsm_subscriber_connection *conn,
			 uint8_t cause, uint8_t *rr_cause);
	/*! \brief BSC->MSC: RR conn has been cleared */
	int (*clear_request)(struct gsm_subscriber_connection *conn,
			      uint32_t cause);
	/*! \brief BSC->MSC: Classmark Update */
	void (*classmark_chg)(struct gsm_subscriber_connection *conn,
			      const uint8_t *cm2, uint8_t cm2_len,
			      const uint8_t *cm3, uint8_t cm3_len);

	/**
	 * Configure the multirate setting on this channel. If it is
	 * not implemented AMR5.9 will be used.
	 */
	void (*mr_config)(struct gsm_subscriber_connection *conn,
				struct gsm_lchan *lchan, int full_rate);

	/** Callback for additional actions during conn cleanup */
	void (*conn_cleanup)(struct gsm_subscriber_connection *conn);
};

uint8_t lchan_to_chosen_channel(struct gsm_lchan *lchan);
uint8_t chan_mode_to_speech(struct gsm_lchan *lchan);

int bsc_api_init(struct gsm_network *network, struct bsc_api *api);
int gsm0808_submit_dtap(struct gsm_subscriber_connection *conn, struct msgb *msg, int link_id, int allow_sacch);
int gsm0808_assign_req(struct gsm_subscriber_connection *conn, int chan_mode, int full_rate);
int gsm0808_cipher_mode(struct gsm_subscriber_connection *conn, int cipher,
			const uint8_t *key, int len, int include_imeisv);
int gsm0808_page(struct gsm_bts *bts, unsigned int page_group,
		 unsigned int mi_len, uint8_t *mi, int chan_type);
int gsm0808_clear(struct gsm_subscriber_connection *conn);

int gsm0408_rcvmsg(struct msgb *msg, uint8_t link_id);
#endif