:pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Tue Nov 27 05:17 CET 2001
[gnokii.git] / include / gsm-api.h
1 /*
2
3   $Id$
4
5   G N O K I I
6
7   A Linux/Unix toolset and driver for Nokia mobile phones.
8
9   Copyright (C) 1999, 2000 Hugh Blemings & Pavel Janík ml.
10
11   Released under the terms of the GNU GPL, see file COPYING for more details.
12         
13   Header file for the various functions, definitions etc. used to implement
14   the handset interface.  See gsm-api.c for more details.
15
16   $Log$
17   Revision 1.1.1.1  2001/11/25 21:59:19  short
18   :pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Sun Nov 25 22:56 CET 2001
19
20   Revision 1.14  2001/06/28 00:28:45  pkot
21   Small docs updates (Pawel Kot)
22
23
24 */
25
26 #ifndef __gsm_api_h
27 #define __gsm_api_h
28
29 /* If gsm-common.h isn't included at this point, little in this file will make
30    sense so we include it here if required. */
31
32 #ifndef __gsm_common_h
33   #include "gsm-common.h"
34 #endif
35
36 /* Ditto rlp_common.h... */
37 #ifndef __data_rlp_common_h
38   #include "data/rlp-common.h"
39 #endif
40
41 #include "gsm-statemachine.h"
42
43 /* Define these as externs so that app code can pick them up. */
44
45 extern bool *GSM_LinkOK;
46 extern GSM_Information *GSM_Info;
47 extern GSM_Functions *GSM;
48 extern GSM_Error (*GSM_F)(GSM_Operation op, GSM_Data *data, GSM_Statemachine *state);
49
50 /* Prototype for the functions actually provided by gsm-api.c. */
51
52 GSM_Error GSM_Initialise(char *model, char *device, char *initlength, GSM_ConnectionType connection, void (*rlp_handler)(RLP_F96Frame *frame), GSM_Statemachine *sm);
53
54 /* All the rest of the API functions are contained in the GSM_Function
55    structure which ultimately points into the model specific code. */
56
57 #endif  /* __gsm_api_h */