libosmogsm 1.13.1.1-afb4 Osmocom GSM library

ipa.h
Go to the documentation of this file.
1
3#pragma once
4
5#include <stdint.h>
6
7#include <osmocom/core/msgb.h>
8#include <osmocom/gsm/tlv.h>
9
10 struct osmo_fd;
11
12/* internal (host-only) data structure */
13 struct ipaccess_unit {
14 uint16_t site_id;
15 uint16_t bts_id;
16 uint16_t trx_id;
17 char *unit_name;
18 char *equipvers;
19 char *swversion;
20 uint8_t mac_addr[6];
21 char *location1;
22 char *location2;
23 char *serno;
24};
25
26/* obtain the human-readable name of an IPA CCM ID TAG */
27 const char *ipa_ccm_idtag_name(uint8_t tag);
28
29 int ipa_ccm_idtag_parse(struct tlv_parsed *dec, unsigned char *buf, int len)
30 OSMO_DEPRECATED("Use ipa_ccm_id_{get,resp}_parse instead");
31 int ipa_ccm_idtag_parse_off(struct tlv_parsed *dec, unsigned char *buf, int len, const int len_offset)
32 OSMO_DEPRECATED_OUTSIDE("Use ipa_ccm_id_{get,resp}_parse instead");
33
34/* parse payload of IPA CCM ID GET into a osmocom TLV style representation */
35 int ipa_ccm_id_get_parse(struct tlv_parsed *dec, const uint8_t *buf, unsigned int len);
36
37/* parse payload of IPA CCM ID RESP into a osmocom TLV style representation */
38 int ipa_ccm_id_resp_parse(struct tlv_parsed *dec, const uint8_t *buf, unsigned int len);
39
40/* parse an Unit ID in string format into the 'ipaccess_unit' data structure */
41 int ipa_parse_unitid(const char *str, struct ipaccess_unit *unit_data);
42
43/* fill a 'struct ipaccess_unit' based on a parsed IDTAG TLV */
44 int ipa_ccm_tlv_to_unitdata(struct ipaccess_unit *ud,
45 const struct tlv_parsed *tp);
46
47
48 struct msgb *ipa_ccm_make_id_resp(const struct ipaccess_unit *dev,
49 const uint8_t *ies_req, unsigned int num_ies_req);
50
51 struct msgb *ipa_ccm_make_id_resp_from_req(const struct ipaccess_unit *dev,
52 const uint8_t *data, unsigned int len);
53
54/* Send an IPA message to the given FD */
55 int ipa_send(int fd, const void *msg, size_t msglen);
56
57/* Send an IPA CCM PONG via the given FD */
58 int ipa_ccm_send_pong(int fd);
59
60/* Send an IPA CCM ID_ACK via the given FD */
61 int ipa_ccm_send_id_ack(int fd);
62
63/* Send an IPA CCM ID_REQ via the given FD */
64 int ipa_ccm_send_id_req(int fd);
65
66/* Common handling of IPA CCM, BSC side */
67 int ipa_ccm_rcvmsg_base(struct msgb *msg, struct osmo_fd *bfd);
68
69/* Common handling of IPA CCM, BTS side */
70 int ipa_ccm_rcvmsg_bts_base(struct msgb *msg, struct osmo_fd *bfd);
71
72/* prepend (push) an ipaccess_head_ext to the msgb */
73 void ipa_prepend_header_ext(struct msgb *msg, int proto);
74
75/* prepend (push) an ipaccess_head to the msgb */
76 void ipa_prepend_header(struct msgb *msg, int proto);
77
78 struct msgb *ipa_msg_alloc(int headroom);
79
80 int ipa_msg_recv(int fd, struct msgb **rmsg);
81 int ipa_msg_recv_buffered(int fd, struct msgb **rmsg, struct msgb **tmp_msg);
ipa_ccm_idtag_name
const char * ipa_ccm_idtag_name(uint8_t tag)
Definition: ipa.c:93
len
uint8_t len
Definition: gsm_04_11.h:0
instead
_parse instead
Definition: ipa.h:30
ipa_ccm_idtag_parse
int ipa_ccm_idtag_parse(struct tlv_parsed *dec, unsigned char *buf, int len) OSMO_DEPRECATED("Use ipa_ccm_id_
Definition: ipa.h:29
msgb.h
ipaccess_unit
Definition: ipa.h:13
ipaccess_unit::location1
char * location1
Definition: ipa.h:21
ipaccess_unit::mac_addr
uint8_t mac_addr[6]
Definition: ipa.h:20
ipaccess_unit::trx_id
uint16_t trx_id
Definition: ipa.h:16
ipaccess_unit::equipvers
char * equipvers
Definition: ipa.h:18
ipaccess_unit::swversion
char * swversion
Definition: ipa.h:19
ipaccess_unit::serno
char * serno
Definition: ipa.h:23
ipaccess_unit::location2
char * location2
Definition: ipa.h:22
ipaccess_unit::unit_name
char * unit_name
Definition: ipa.h:17
ipaccess_unit::site_id
uint16_t site_id
Definition: ipa.h:14
ipaccess_unit::bts_id
uint16_t bts_id
Definition: ipa.h:15
osmo_fd
tlv_parsed
result of the TLV parser
Definition: tlv.h:532
tlv.h