Gitiles
Code Review Sign In
gerrit.osmocom.org / libosmocore / 8930911c00e7c267826fd696e30c47aa5c92bf57 / . / include / osmocom / gsm / protocol / gsm_23_041.h
blob: 564946c6217dae1a4b9e78eec80138f74ccdd4f0 [file] [log] [blame]
Harald Welte3f27f712019-06-14 19:31:30 +0200[diff] [blame]1#pragma once
2
Neels Hofmeyr12f109b2020-05-14 17:28:57 +0200[diff] [blame]3#include <osmocom/core/endian.h>
4
Pau Espin Pedrol0893f0f2022-07-22 19:08:14 +0200[diff] [blame]5/* Section 9.3.24: Warning-Type */
6enum gsm23041_warning_type_value {
7 CBS_ETWS_WARN_TYPE_EARTHQUAKE = 0,
8 CBS_ETWS_WARN_TYPE_TSUNAMI = 1,
9 CBS_ETWS_WARN_TYPE_EARTHQUAKE_AND_TSUNAMI = 2,
10 CBS_ETWS_WARN_TYPE_TEST = 3,
11 CBS_ETWS_WARN_TYPE_OTHER = 4,
12 /* 0000101-1111111 Reserved for future use */
13};
14
Harald Welte3f27f712019-06-14 19:31:30 +0200[diff] [blame]15/* Section 9.4.1.2: GSM Message Format */
16struct gsm23041_msg_param_gsm {
17 uint16_t serial_nr;
18 uint16_t message_id;
19 uint8_t dcs;
20 struct {
21#if OSMO_IS_LITTLE_ENDIAN
22 uint8_t num_pages:4,
23 page_nr:4;
Neels Hofmeyr534f0f42020-05-14 17:28:39 +0200[diff] [blame]24#elif OSMO_IS_BIG_ENDIAN
25/* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */
26 uint8_t page_nr:4, num_pages:4;
Harald Welte3f27f712019-06-14 19:31:30 +0200[diff] [blame]27#endif
28 } page_param;
29 uint8_t content[0];
30} __attribute__ ((packed));
31
32/* Section 9.4.1.2.2 Message Identifier */
33enum {
34 /* 0 - 999: Allocated by GSM AD.26 */
35 CBS_MSGID_LCS_EOTD_ASSIST = 1000,
36 CBS_MSGID_LCS_DGPS_CORRECTION = 1001,
37 CBS_MSGID_LCS_GPS_EPHEM_CLOCK = 1002,
38 CBS_MSGID_LCS_GPS_ALMANAC_OTHER = 1003,
39 /* 1004 - 4095: RFU */
40 /* 4096 - 4223: clear text SIM data download */
41 /* 4224 - 4351: secured SIM data download */
42 CBS_MSGID_ETWS_EARTHQUAKE = 4352,
43 CBS_MSGID_ETWS_TSUNAMI = 4353,
44 CBS_MSGID_ETWS_EARTHQUAKE_TSUNAMI = 4354,
45 CBS_MSGID_ETWS_TEST = 4355,
46 CBS_MSGID_ETWS_OTHER = 4356,
47 /* 4357 - 4359: ETWS RFU */
48 /* 4360 - 4369: RFU */
49 CBS_MSGID_CMAS_PRESIDENTIAL = 4370,
50 CBS_MSGID_CMAS_EXTREME_IMMEDIATE_OBSERVED = 4371,
51 CBS_MSGID_CMAS_EXTREME_IMMEDIATE_LIKELY = 4372,
52 CBS_MSGID_CMAS_EXTREME_EXPECTED_OBSERVED = 4373,
53 CBS_MSGID_CMAS_EXTREME_EXPECTED_LIKELY = 4374,
54 CBS_MSGID_CMAS_SEVERE_IMMEDIATE_OBSERVED = 4375,
55 CBS_MSGID_CMAS_SEVERE_IMMEDIATE_LIKELY = 4376,
56 CBS_MSGID_CMAS_SEVERE_EXPECTED_OBSERVED = 4377,
57 CBS_MSGID_CMAS_SEVERE_EXPECTED_LIKELY = 4378,
58 CBS_MSGID_CMAS_AMBER = 4379,
59 CBS_MSGID_CMAS_MONTHLY_TEST = 4380,
60 CBS_MSGID_CMAS_EXERCISE = 4381,
61 CBS_MSGID_CMAS_OPERATOR_DEFINED = 4382,
62 CBS_MSGID_CMAS_PRESIDENTIAL_ADDL = 4383,
63 CBS_MSGID_CMAS_EXTREME_IMMEDIATE_OBSERVED_ADDL = 4384,
64 CBS_MSGID_CMAS_EXTREME_IMMEDIATE_LIKELY_ADDL = 4385,
65 CBS_MSGID_CMAS_EXTREME_EXPECTED_OBSERVED_ADDL = 4386,
66 CBS_MSGID_CMAS_EXTREME_EXPECTED_LIKELY_ADDL = 4387,
67 CBS_MSGID_CMAS_SEVERE_IMMEDIATE_OBSERVED_ADDL = 4388,
68 CBS_MSGID_CMAS_SEVERE_IMMEDIATE_LIKELY_ADDL = 4389,
69 CBS_MSGID_CMAS_SEVERE_EXPECTED_OBSERVED_ADDL = 4390,
70 CBS_MSGID_CMAS_SEVERE_EXPECTED_LIKELY_ADDL = 4391,
71 CBS_MSGID_CMAS_AMBER_ADDL = 4392,
72 CBS_MSGID_CMAS_MONTHLY_TEST_ADDL = 4393,
73 CBS_MSGID_CMAS_EXERCISE_ADDL = 4394,
74 CBS_MSGID_CMAS_OPERATOR_DEFINED_ADDL = 4395,
75 /* 4396 - 4399: RFU CMAS / EU-Alert */
76 /* 4400 - 6399: RFU PWS */
77 CBS_MSGID_EU_INFO_LOCAL_LANG = 6400,
78 /* 6491 - 40959: RFU */
79 /* 40960 - 45055: PLMN operator specific range */
80 /* 45056 - 61439: PLMN operator specific range RFU */
81 /* 61440 - 65534: PLMN operator specific range */
82 CBS_MSGID_RESERVED = 65535
83};
84
85/* Section 9.4.1.3.2 ETWS Primary Notification Message Parameter */
86struct gsm23041_etws_primary_gsm {
87 uint16_t serial_nr;
88 uint16_t message_id;
89 uint16_t warning_type;
90 uint8_t warning_sec_info[50];
91} __attribute__ ((packed));
92
93
94/* Section 9.4.2.2 UMTS Message Parameter */
95struct gsm23041_msg_param_umts {
96 uint8_t msg_type; /* as per TS 25.324 */
97 uint16_t message_id;
98 uint16_t serial_nr;
99 uint8_t dcs;
100 uint8_t content[0];
101} __attribute__ ((packed));