Update: orig2001_11_27_05_17 -> orig2001_11_27_22_58
[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.12.1  2001/11/27 23:34:48  short
18   Update: orig2001_11_27_05_17 -> orig2001_11_27_22_58
19
20   Revision 1.1.1.1.8.1  2001/11/27 23:06:09  short
21   Update: orig2001_11_27_05_17 -> orig2001_11_27_22_58
22
23   Revision 1.1.1.1.2.1  2001/11/27 22:48:37  short
24   Update: orig2001_11_27_05_17 -> orig2001_11_27_22_58
25
26   Revision 1.1.1.2  2001/11/27 22:01:26  short
27   :pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Tue Nov 27 22:58 CET 2001
28
29   Revision 1.15  2001/11/27 12:19:01  pkot
30   Cleanup, indentation, ANSI complaint preprocesor symbols (Jan Kratochvil, me)
31
32   Revision 1.14  2001/06/28 00:28:45  pkot
33   Small docs updates (Pawel Kot)
34
35
36 */
37
38 #ifndef __gsm_api_h
39 #define __gsm_api_h
40
41 /* If gsm-common.h isn't included at this point, little in this file will make
42    sense so we include it here if required. */
43
44 #ifndef __gsm_common_h
45 #  include "gsm-common.h"
46 #endif
47
48 /* Ditto rlp_common.h... */
49 #ifndef __data_rlp_common_h
50 #  include "data/rlp-common.h"
51 #endif
52
53 #include "gsm-statemachine.h"
54
55 /* Define these as externs so that app code can pick them up. */
56
57 extern bool *GSM_LinkOK;
58 extern GSM_Information *GSM_Info;
59 extern GSM_Functions *GSM;
60 extern GSM_Error (*GSM_F)(GSM_Operation op, GSM_Data *data, GSM_Statemachine *state);
61
62 /* Prototype for the functions actually provided by gsm-api.c. */
63
64 GSM_Error GSM_Initialise(char *model, char *device, char *initlength, GSM_ConnectionType connection, void (*rlp_handler)(RLP_F96Frame *frame), GSM_Statemachine *sm);
65
66 /* All the rest of the API functions are contained in the GSM_Function
67    structure which ultimately points into the model specific code. */
68
69 #endif  /* __gsm_api_h */