freecalypso-citrine: g23m-aci/gdd

annotate g23m-aci/gdd_dio/gdd.h @ 3:f93dab57b032

L1/include: TCS211-based version restored

author	Mychaela Falconia <falcon@freecalypso.org>
date	Thu, 09 Jun 2016 00:45:00 +0000
parents	75a11d740a02
children

rev	line source
0 75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 +-----------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3 \| Project : GSM-F&D (8411)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 \| Modul : BAT library
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5 +-----------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 \| Copyright 2002 Texas Instruments Berlin, AG
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7 \| All rights reserved.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9 \| This file is confidential and a trade secret of Texas
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 \| Instruments Berlin, AG
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11 \| The receipt of or possession of this file does not convey
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12 \| any rights to reproduce or disclose its contents or to
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 \| manufacture, use, or sell anything it may describe, in
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14 \| whole, or in part, without the specific written consent of
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 \| Texas Instruments Berlin, AG.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 +-----------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 \| Purpose : API of the Generic Data aDapter (GDD) which connects the
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 \| application domain with the protocol stack.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 +-----------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 #ifndef GDD_H
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23 #define GDD_H
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25 /==== INCLUDES =============================================================/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27 /==== DEFINITIONS ==========================================================/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29 /** Return and error values of GDD functions */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 enum GDD_RESULT_CODES
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32 GDD_OK = 0, /* OK, no error occured */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 GDD_BUSY = 1, /* Currently busy */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34 GDD_DIO_NOT_READY = 2, /* Dio not initialized or ready */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 GDD_NO_CONNECTION_SLOT = 3, /* Max number of connections already open */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36 GDD_NO_BUF_AVAILABLE = 4, /* No buffer available (for sending) */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 GDD_INVALID_PARAMS = 5, /* Invalid input parameter */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38 GDD_REQ_BUF_TOO_LARGE = 6, /* Requested buffer too large */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39 GDD_INVALID_BUFFER = 7, /* Invalid buffer */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40 GDD_ALREADY_INITIALIZED = 97, /* Instance already initialized */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41 GDD_NO_MEMORY = 98, /* Memory allocation during initialization failed */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42 GDD_INTERNAL_ERROR = 99 /* General error code for all other errors */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 };
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46 /==== CONSTS ===============================================================/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48 /** This size that's required for maintenance of one single connection.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 Only needed if the application must allocated memory to be passed into
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 gdd_init(). */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 #define GDD_DIO_SIZEOF_CONDATA 64
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53 /** Size of first buffer segment (used for internal purposes) */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 #define GDD_DIO_PID_SEG_SIZE 2
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 /==== TYPES =================================================================/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59 /** Connection handle */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 typedef U32 T_GDD_CON_HANDLE;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 /** Identifier for the adapter instances - each instance corresponds to a
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 DIO driver type */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 typedef enum
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 GDD_INST_NONE = -1,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 GDD_INST_BAT = 0, /* The BAT library */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69 GDD_INST_APP, /* Application */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70 GDD_INST_TCP, /* TCPIP entity */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 GDD_INST_SOCK, /* Socket library */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72 GDD_INST_SOCKCFG, /* Socket library configuration */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74 /* Add new instances here and increase GDD_NUM_INSTS accordingly */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 GDD_NUM_INSTS,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76 /* Maximum number of instances is defined by GDD_MAX_INST_ID */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77 GDD_MAX_INST_ID = 255
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 } T_GDD_INST_ID;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82 * GDD data format - identicial to DIOv4 data format.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 typedef struct
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 U8 _align0; /< 0: 1> alignment /
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 U8 _align1; /< 1: 1> alignment /
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 U16 c_data; /< 2: 2> counter /
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 U8 ptr_data; /< 4: 4> pointer to pointer to the first
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90 byte of the data buffer segment */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91 } T_GDD_SEGMENT;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93 typedef struct
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 U16 length; /< 0: 2> len of dio_ctrl /
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 U8 _align0; /< 2: 1> alignment /
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 U8 c_segment; /< 3: 1> counter of segments /
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 T_GDD_SEGMENT ptr_gdd_segment; /< 4: 4> pointer to Structured Element */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 } T_GDD_BUF;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103 /** Capabilities of DIO BAT adapter, to be set by the client */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104 typedef struct
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 U32 mtu_size;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 } T_GDD_DIO_CAP;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110 /** Capabilities of the BAT adapter, to be set by the client */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111 typedef union
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 T_GDD_DIO_CAP dio_cap;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 /* Capabilities for future adapter implementations to be added here */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 } T_GDD_CAP;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118 /** GDD result type */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119 typedef U16 GDD_RESULT;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122 /** Signal types */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123 typedef enum
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125 GDD_SIGTYPE_CONNECTION_OPENED = 1, /* Connection is established and usable */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 GDD_SIGTYPE_CONNECTION_FAILED = 2, /* Connection failed or closed down unexpectedly */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 GDD_SIGTYPE_SEND_BUF_AVAILABLE = 3, /* A new send buffer becomes available after an
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 unsuccessfull call to gdd_get_send_buffer */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 GDD_SIGTYPE_BUF_SENT = 4 /* Indicates that the last sent buffer has been
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 successfully sent */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 } T_GDD_SIGTYPE;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135 /** Data associated with a GDD signal */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136 typedef struct
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 T_GDD_SIGTYPE sig;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139 } T_GDD_SIGNAL;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143 /***************************************************************************
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 * Call-back function definitions (to be implemented by the client)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 ***************************************************************************/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 \| Function : gdd_signal_cb
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152 \| Description : The adapter calls this call-back function to send received data
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153 \| to the client. The client must copy the data contained in the
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154 \| buffer, since the buffer will be invalidated upon returning
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155 \| from this function.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 \| Alternatively, the client can indicate that he is currently
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157 \| busy. In this case, he has to call gdd_signal_ready_rcv() at a
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 \| later time to invoke this call-back function again.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160 \| Parameters : sig - Signal
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	163 typedef void (* T_GDD_SIGNAL_CB)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	164 ( T_GDD_CON_HANDLE con,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	165 T_GDD_SIGNAL sig );
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	167 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	168 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	169 \| Function : gdd_received_data_cb
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	170 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	171 \| Description : The adapter calls this callback function to signal events to
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	172 \| the client.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	173 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	174 \| Parameters : sig - Signal
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	176 \| Return : GDD_OK - Data was copied by client
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	177 \| GDD_BUSY - Client was busy and could not receive data.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	178 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	179 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180 typedef GDD_RESULT (* T_GDD_RECEIVE_DATA_CB)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	181 ( T_GDD_CON_HANDLE con,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	182 T_GDD_BUF * buf );
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	183
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	184
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	185 /***************************************************************************
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	186 * Function definitions
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	187 ***************************************************************************/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	188
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	190 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 \| Function : gdd_init
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193 \| Description : This optional function can be used to provide the house-keeping
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194 \| memory required for the given adapter instance. On platforms
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195 \| where memory allocation is available, the function might be
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	196 \| called with the parameter mem set to 0. In this case, it is
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197 \| just use to limit the number of connections via the parameter
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	198 \| num_con.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	200 \| Parameters : inst - Instance identifier of the adapter
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201 \| mem - Memory allocated by client for maintenance
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	202 \| of the connections (Input parameter).
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	203 \| If set to 0, the adapter will allocate
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204 \| the memory itself.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205 \| num_con - Maximum number of connections
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	206 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	207 \| Return : GDD_OK - Initialization successful
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	208 \| >GDD_OK - Error (see manual for error codes)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	209 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	210 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	211 typedef GDD_RESULT (* T_GDD_INIT)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	212 ( T_GDD_INST_ID inst,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	213 void * mem,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	214 U16 num_con);
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	215
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	216
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	217 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	218 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	219 \| Function : gdd_deinit
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	220 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	221 \| Description : This function de-initializes an adapter instance.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	222 \| Any memory that the adapter has allocated internally is freed.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	223 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	224 \| Parameters : inst - Instance identifier of the adapter
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	225 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	226 \| Return : GDD_OK - Initialization successful
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	227 \| >GDD_OK - Error (see manual for error codes)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	228 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	229 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	230 typedef GDD_RESULT (* T_GDD_DEINIT)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	231 ( T_GDD_INST_ID inst);
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	232
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	233
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	234 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	235 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	236 \| Function : gdd_connect
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	237 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	238 \| Description : This function prepares a new connection for data transmission.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	239 \| If the function succeeds, it will return a connection handle
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	240 \| in the parameter 'con_handle' to the caller. Each connection is
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	241 \| uniquely identified by its connection handle.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	242 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	243 \| Note : The connection cannot be used straight away. Instead, the
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	244 \| client receives a signal GDD_SIGTYPE_CONNECTION_OPENED when the
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	245 \| connection setup has been finished.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	246 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	247 \| Each open connection should be closed using the function
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	248 \| gdd_close() when it is not used any longer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	249 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	250 \| Parameters : inst - Instance identifier of the adapter
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	251 \| con_handle - New handle to the adapter passed back to the
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	252 \| caller (output parameter).
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	253 \| cap - capabilities of the adapter
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	254 \| rcv_cb - Call-back for receiving data (provided by client)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	255 \| sig_cb - Call-back for signals (provided by client)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	256 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	257 \| Return : GDD_OK - Connecting is setup and being created. The client
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	258 \| has to wait for signal GDD_SIGTYPE_CONNECTION_OPENED
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	259 \| before the connection is usable.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	260 \| >GDD_OK - Error (see manual for error codes)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	261 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	262 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	263 typedef GDD_RESULT (* T_GDD_CONNECT)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	264 ( T_GDD_INST_ID inst,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	265 T_GDD_CON_HANDLE * con_handle,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	266 const T_GDD_CAP * cap,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	267 T_GDD_RECEIVE_DATA_CB rcv_cb,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	268 T_GDD_SIGNAL_CB sig_cb );
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	269
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	270
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	271 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	272 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	273 \| Function : gdd_disconnect
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	274 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	275 \| Description : This function closes and deletes a connection.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	276 \| The connection handle will not be valid any longer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	277 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	278 \| Parameters : con_handle - Handle to the connection to be closed
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	279 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	280 \| Return : GDD_OK - Initialization successful
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	281 \| >GDD_OK - Error (see manual for error codes)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	282 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	283 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	284 typedef GDD_RESULT (* T_GDD_DISCONNECT)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	285 ( T_GDD_CON_HANDLE con_handle );
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	286
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	287
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	288 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	289 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	290 \| Function : gdd_get_send_buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	291 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	292 \| Description : This function request a send buffer of a minimum size data_size
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	293 \| for sending on the connection specified with con. The buffer is
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	294 \| passed back in the parameter 'buf'.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	295 \| After a successful call to this function, it is the
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	296 \| responsibility of the caller to subsequently fill the buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	297 \| and call gdd_send_data(), before another call to
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	298 \| gdd_get_send_buffer() is done. In other words, the client must
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	299 \| make sure that calls to these two functions are synchronized.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	300 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	301 \| Parameters : con_handle - Connection handle
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	302 \| buf - Pointer to pointer to send buffer (out parameter)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	303 \| data_size - Minimum size of requested buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	304 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	305 \| Return : GDD_OK - Initialization successful
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	306 \| >GDD_OK - Error (see manual for error codes)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	307 \| GDD_NO_BUF_AVAILABLE - No buffer available. The client
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	308 \| will be notified with a signal
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	309 \| GDD_SIGTYPE_SEND_BUF_AVAILABLE when a
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	310 \| buffer is ready and can be requested.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	311 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	312 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	313 typedef GDD_RESULT (* T_GDD_GET_SEND_BUFFER)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	314 ( T_GDD_CON_HANDLE con_handle,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	315 T_GDD_BUF ** buf,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	316 U16 data_size );
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	317
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	318
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	319 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	320 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	321 \| Function : gdd_send_data
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	322 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	323 \| Description : This functions sends a buffer over the specified connection.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	324 \| Please see also description of gdd_get_send_buffer().
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	325 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	326 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	327 \| Parameters : con_handle - Connection handle
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	328 \| buf - Buffer to be sent
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	329 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	330 \| Return : GDD_OK - Initialization successful
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	331 \| >GDD_OK - Error (see manual for error codes)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	332 \| GDD_INVALID_BUFFER - The buffer pointed to is incorrect, i.e.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	333 \| not the one that was previously requested
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	334 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	335 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	336 typedef GDD_RESULT (* T_GDD_SEND_DATA)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	337 ( T_GDD_CON_HANDLE con,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	338 T_GDD_BUF * buf);
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	339
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	340
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	341 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	342 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	343 \| Function : gdd_signal_ready_rcv
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	344 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	345 \| Description : This function is called from the client to indicate that he
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	346 \| is ready to receive. Typically, it is called from the client
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	347 \| when he becomes ready after a preceding result callback
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	348 \| (result_cb) was returned with GDD_BUSY.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	349 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	350 \| Parameters : con_handle - Connection handle
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	351 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	352 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	353 typedef void (* T_GDD_SIGNAL_READY_RCV)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	354 ( T_GDD_CON_HANDLE con );
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	355
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	356
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	357 /** GDD Function pointer table */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	358 typedef struct
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	359 {
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	360 T_GDD_INIT gdd_init;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	361 T_GDD_DEINIT gdd_deinit;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	362 T_GDD_CONNECT gdd_connect;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	363 T_GDD_DISCONNECT gdd_disconnect;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	364 T_GDD_GET_SEND_BUFFER gdd_get_send_buffer;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	365 T_GDD_SEND_DATA gdd_send_data;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	366 T_GDD_SIGNAL_READY_RCV gdd_signal_ready_rcv;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	367 } T_GDD_FUNC;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	368
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	369
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	370 /** Needed for initialization of client of BAT adapter (BAT library) */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	371 extern T_GDD_FUNC gdd_func_dio;
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	372
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	373
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	374 /***************************************************************************
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	375 * Helper function definitions
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	376 ***************************************************************************/
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	377
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	378 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	379 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	380 \| Function : gdd_write_buf
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	381 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	382 \| Description : Write data from a client buffer into into a GDD buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	383 \| The datagram protocol ID for the following link layer (PPP) is
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	384 \| set internally to 0x21 (IPv4). If you need to set the protocol
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	385 \| ID to something else, please use the function
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	386 \| gdd_write_buf_with_pid()..
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	387 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	388 \| Parameters : src_buf - Source buffer (client owned)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	389 \| src_size - Size of source buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	390 \| dest_buf - Destination buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	391 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	392 \| Return : 0 if all bytes have been written to the destination buffer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	393 \| If not all bytes could be written, the return value is larger
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	394 \| than 0 and denotes the number of remaining (unwritten) bytes.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	395 \| A negative return value indicates an error.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	396 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	397 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	398 S32 gdd_write_buf(const U8 * src_buf, U16 src_size, T_GDD_BUF * dest_buf);
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	399
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	400 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	401 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	402 \| Description : Write user data and a datagram protocol ID used by the link
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	403 \| layer (PPP) into a GDD buffer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	404 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	405 \| Parameters : src_buf - Source buffer (client owned)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	406 \| src_size - Size of source buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	407 \| dest_buf - Destination buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	408 \| protocol_id - datagram protocol identifier
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	409 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	410 \| Return : 0 if all bytes have been written to the destination buffer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	411 \| If not all bytes could be written, the return value is larger
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	412 \| than 0 and denotes the number of remaining (unwritten) bytes.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	413 \| A negative return value indicates an error.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	414 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	415 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	416 S32 gdd_write_buf_with_pid(const U8 * src_buf, U16 src_size,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	417 T_GDD_BUF * dest_buf,U8 protocol_id);
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	418
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	419
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	420 /*
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	421 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	422 \| Function : gdd_read_buf
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	423 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	424 \| Description : Read data from a GDD buffer into a client buffer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	425 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	426 \| Parameters : src_buf - Source buffer received from GDD
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	427 \| dest_buf - Destination buffer (client owned)
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	428 \| dest_size - Size of destination buffer
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	429 \|
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	430 \| Return : 0 if all bytes have been copied into the destination buffer.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	431 \| If not all bytes could be copied into the destination buffer,
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	432 \| the return value is larger than 0 and denotes the number of
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	433 \| remaining (unread) bytes. A negative return value indicase an
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	434 \| error.
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	435 +------------------------------------------------------------------------------
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	436 */
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	437 S32 gdd_read_buf(const T_GDD_BUF * src_buf, U8 * dest_buf, U16 dest_size);
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	438
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	439
75a11d740a02 initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7 Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	440 #endif /* GDD_H */

FreeCalypso > hg > freecalypso-citrine

annotate g23m-aci/gdd_dio/gdd.h @ 3:f93dab57b032