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