annotate include/tmgw_ctrl.h @ 275:def9f6e4f49e default tip

doc/Use-outside-USA: Fake-NANP-numbers article is here
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 27 Nov 2023 21:49:19 -0800
parents f062c32a5116
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 /*
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 * This header file defines the ad hoc control interface
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 * to themwi-mgw over a dedicated local socket.
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 */
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 struct tmgw_ctrl_req {
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 uint32_t opcode;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 uint32_t transact_ref;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 uint32_t ep_id;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 uint32_t setup_mask;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 struct sockaddr_storage gsm_addr;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 uint32_t gsm_payload_type;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 uint32_t gsm_payload_msg_type;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 struct sockaddr_storage pstn_addr;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 uint32_t pstn_payload_type;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 uint32_t fwd_mode;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 };
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19 #define TMGW_CTRL_OP_CRCX 1
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 #define TMGW_CTRL_OP_MDCX 2
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 #define TMGW_CTRL_OP_DLCX 3
125
5081f2bc6f1c include/tmgw_ctrl.h: define commands for DTMF start & stop
Mychaela Falconia <falcon@freecalypso.org>
parents: 34
diff changeset
22 #define TMGW_CTRL_OP_DTMF_START 4
5081f2bc6f1c include/tmgw_ctrl.h: define commands for DTMF start & stop
Mychaela Falconia <falcon@freecalypso.org>
parents: 34
diff changeset
23 #define TMGW_CTRL_OP_DTMF_STOP 5
30
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 #define TMGW_CTRL_MASK_GSM_CONN 0x0001
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 #define TMGW_CTRL_MASK_PSTN_CONN 0x0002
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 #define TMGW_CTRL_MASK_FWD_MODE 0x0004
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 struct tmgw_ctrl_resp {
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 uint32_t transact_ref;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 uint32_t res;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 uint32_t ep_id;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33 struct sockaddr_storage gsm_addr;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 struct sockaddr_storage pstn_addr;
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 };
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 #define TMGW_RESP_OK 0
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 #define TMGW_RESP_ERR_PROT 1
496f359226ab include: constant and interface headers for themwi-mgw
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 #define TMGW_RESP_ERR_RSRC 2
34
7dae2bae56a1 themwi-mgw: implement MDCX parameter validation
Mychaela Falconia <falcon@freecalypso.org>
parents: 30
diff changeset
40 #define TMGW_RESP_ERR_OPCODE 3
7dae2bae56a1 themwi-mgw: implement MDCX parameter validation
Mychaela Falconia <falcon@freecalypso.org>
parents: 30
diff changeset
41 #define TMGW_RESP_ERR_PARAM 4
7dae2bae56a1 themwi-mgw: implement MDCX parameter validation
Mychaela Falconia <falcon@freecalypso.org>
parents: 30
diff changeset
42 #define TMGW_RESP_ERR_NOTSUP 5
127
f062c32a5116 mgw: implement DTMF
Mychaela Falconia <falcon@freecalypso.org>
parents: 125
diff changeset
43 #define TMGW_RESP_ERR_BUSY 6
f062c32a5116 mgw: implement DTMF
Mychaela Falconia <falcon@freecalypso.org>
parents: 125
diff changeset
44 #define TMGW_RESP_ERR_NOTRDY 7