Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file ipa.h */ |
| 2 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 3 | #pragma once |
| 4 | |
| 5 | #include <stdint.h> |
| 6 | |
| 7 | #include <osmocom/core/msgb.h> |
| 8 | #include <osmocom/gsm/tlv.h> |
| 9 | |
Jacob Erlbeck | 3cd6753 | 2014-12-22 10:58:45 +0100 | [diff] [blame] | 10 | struct osmo_fd; |
| 11 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 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 */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 27 | const char *ipa_ccm_idtag_name(uint8_t tag); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 28 | |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 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"); |
Harald Welte | 5a7740d | 2018-08-01 17:29:48 +0200 | [diff] [blame] | 31 | int ipa_ccm_idtag_parse_off(struct tlv_parsed *dec, unsigned char *buf, int len, const int len_offset) |
| 32 | OSMO_DEPRECATED("Use ipa_ccm_id_{get,resp}_parse instead"); |
Harald Welte | 7869baf | 2018-07-31 20:25:48 +0200 | [diff] [blame] | 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); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 39 | |
| 40 | /* parse an Unit ID in string format into the 'ipaccess_unit' data structure */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 41 | int ipa_parse_unitid(const char *str, struct ipaccess_unit *unit_data); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 42 | |
| 43 | /* fill a 'struct ipaccess_unit' based on a parsed IDTAG TLV */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 44 | int ipa_ccm_tlv_to_unitdata(struct ipaccess_unit *ud, |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 45 | const struct tlv_parsed *tp); |
| 46 | |
Harald Welte | 7bc88bb | 2017-04-15 19:05:33 +0200 | [diff] [blame] | 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 | |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 54 | /* Send an IPA message to the given FD */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 55 | int ipa_send(int fd, const void *msg, size_t msglen); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 56 | |
| 57 | /* Send an IPA CCM PONG via the given FD */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 58 | int ipa_ccm_send_pong(int fd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 59 | |
| 60 | /* Send an IPA CCM ID_ACK via the given FD */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 61 | int ipa_ccm_send_id_ack(int fd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 62 | |
| 63 | /* Send an IPA CCM ID_REQ via the given FD */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 64 | int ipa_ccm_send_id_req(int fd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 65 | |
| 66 | /* Common handling of IPA CCM, BSC side */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 67 | int ipa_ccm_rcvmsg_base(struct msgb *msg, struct osmo_fd *bfd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 68 | |
| 69 | /* Common handling of IPA CCM, BTS side */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 70 | int ipa_ccm_rcvmsg_bts_base(struct msgb *msg, struct osmo_fd *bfd); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 71 | |
| 72 | /* prepend (push) an ipaccess_head_ext to the msgb */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 73 | void ipa_prepend_header_ext(struct msgb *msg, int proto); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 74 | |
| 75 | /* prepend (push) an ipaccess_head to the msgb */ |
Harald Welte | e391996 | 2014-08-20 22:28:23 +0200 | [diff] [blame] | 76 | void ipa_prepend_header(struct msgb *msg, int proto); |
Harald Welte | 28aa991 | 2014-08-20 22:06:04 +0200 | [diff] [blame] | 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); |