summaryrefslogtreecommitdiff
path: root/include/libgsmd/libgsmd.h
blob: 3fce0f04a4eb6adbfb6bd6609570a18b686d4894 (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
#ifndef _LIBGSMD_H
#define _LIBGSMD_H

/* libgsmd.h - Library API for gsmd, the GSM Daemon
 * (C) 2006 by Harald Welte <hwelte@hmw-consulting.de>
 * Development funded by First International Computers, Inc.
 */

#include <sys/types.h>
#include <errno.h>

#include <gsmd/usock.h>

/* Generic Information
 *
 * Return value:
 * 	< 0	Error, see libgsmd/errno.h and errno.h
 * 	= 0	Success
 * 	> 0	Success, number of information elements returned
 *
 * Allocation:
 * 	All data structures are caller-allocated.  The only exception
 * 	is struct lgsm_handle which is allocatedi in lgsm_init() and 
 * 	free'd in lgsm_exit()
 *
 * References:
 * 	Recefences to "Chapter X" are referring to 3GPP TS 07.07 version 7.8.0
 */

/* Opaque data structure, content only known to libgsm implementation */
struct lgsm_handle;

/* Refer to GSM 04.08 [8] subclause 10.5.4.7 */
enum lgsm_addr_type {
	LGSM_ATYPE_ISDN_UNKN		= 161,
	//LGSM_ATYPE_ISDN_INTL		= ,
	//LGSM_ATYPE_ISDN_NATIONAL	= ,
};

#define LGSM_ADDR_MAXLEN	31
struct lgsm_addr {
	enum lgsm_addr_type type;
	char addr[LGSM_ADDR_MAXLEN+1];
};

typedef int lgsm_msg_handler(struct lgsm_handle *lh, struct gsmd_msg_hdr *gmh);

#define LGSMD_DEVICE_GSMD	"gsmd"

/* initialize usage of libgsmd, obtain handle for othe API calls */
extern struct lgsm_handle *lgsm_init(const char *device);
extern struct lgsm_handle *lgsm_init_inst(unsigned int instance);

/* Terminate usage of libgsmd */
extern int lgsm_exit(struct lgsm_handle *lh); 

/* Obtain file descriptor (e.g. for select-loop under app control) */
extern int lgsm_fd(struct lgsm_handle *lh);

extern int lgsm_register_handler(struct lgsm_handle *lh, int type, lgsm_msg_handler *handler);
extern void lgsm_unregister_handler(struct lgsm_handle *lh, int type);

extern int lgsm_passthrough_send(struct lgsm_handle *lh, const char *tx);
extern int lgsm_passthrough(struct lgsm_handle *lh, const char *tx, char *rx, unsigned int *rx_len);
extern int lgsm_subscriptions(struct lgsm_handle *lh, u_int32_t subscriptions);

extern struct gsmd_msg_hdr *lgsm_gmh_fill(int type, int subtype, int payload_len);
extern int lgsm_send(struct lgsm_handle *lh, struct gsmd_msg_hdr *gmh);
extern int lgsm_handle_packet(struct lgsm_handle *lh, char *buf, int len);
extern int lgsm_blocking_wait_packet(struct lgsm_handle *lh, u_int16_t id,
		struct gsmd_msg_hdr *gmh, int rlen);

extern void *lgsm_get_user_data(struct lgsm_handle *lh);
extern void lgsm_set_user_data(struct lgsm_handle *lh, void *data);

#endif
personal git repositories of Harald Welte. Your mileage may vary