Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file gsm_03_41.h |
| 2 | * GSM TS 03.41 definitions also TS 23.041. */ |
| 3 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 4 | #pragma once |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 5 | |
| 6 | #include <stdint.h> |
| 7 | |
Ruben Undheim | 771a58f | 2015-12-09 20:22:42 +0100 | [diff] [blame] | 8 | #include <osmocom/core/endian.h> |
Harald Welte | 61ced83 | 2014-12-30 13:18:26 +0100 | [diff] [blame] | 9 | #include <osmocom/gsm/protocol/gsm_04_12.h> |
| 10 | |
Ruben Undheim | 771a58f | 2015-12-09 20:22:42 +0100 | [diff] [blame] | 11 | #ifndef OSMO_IS_LITTLE_ENDIAN |
| 12 | #define OSMO_IS_LITTLE_ENDIAN 0 |
| 13 | #endif |
| 14 | |
Harald Welte | 61ced83 | 2014-12-30 13:18:26 +0100 | [diff] [blame] | 15 | #define GSM341_MAX_PAYLOAD (GSM412_MSG_LEN-sizeof(struct gsm341_ms_message)) |
| 16 | #define GSM341_MAX_CHARS (GSM341_MAX_PAYLOAD*8/7) |
Harald Welte | c13cf8b | 2014-12-30 13:25:44 +0100 | [diff] [blame] | 17 | #define GSM341_7BIT_PADDING '\r' |
Harald Welte | 61ced83 | 2014-12-30 13:18:26 +0100 | [diff] [blame] | 18 | |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 19 | /* Chapter 9.3.2 */ |
| 20 | struct gsm341_ms_message { |
| 21 | struct { |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 22 | #if OSMO_IS_LITTLE_ENDIAN |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 23 | uint8_t code_hi:6; |
| 24 | uint8_t gs:2; |
Holger Hans Peter Freyther | a1e8bf7 | 2010-12-29 12:00:01 +0100 | [diff] [blame] | 25 | uint8_t update:4; |
| 26 | uint8_t code_lo:4; |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 27 | #elif OSMO_IS_BIG_ENDIAN |
| 28 | /* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ |
| 29 | uint8_t gs:2, code_hi:6; |
| 30 | uint8_t code_lo:4, update:4; |
Ruben Undheim | 771a58f | 2015-12-09 20:22:42 +0100 | [diff] [blame] | 31 | #endif |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 32 | } serial; |
| 33 | uint16_t msg_id; |
| 34 | struct { |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 35 | #if OSMO_IS_LITTLE_ENDIAN |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 36 | uint8_t language:4; |
| 37 | uint8_t group:4; |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 38 | #elif OSMO_IS_BIG_ENDIAN |
| 39 | /* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ |
| 40 | uint8_t group:4, language:4; |
Ruben Undheim | 771a58f | 2015-12-09 20:22:42 +0100 | [diff] [blame] | 41 | #endif |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 42 | } dcs; |
| 43 | struct { |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 44 | #if OSMO_IS_LITTLE_ENDIAN |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 45 | uint8_t total:4; |
| 46 | uint8_t current:4; |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 47 | #elif OSMO_IS_BIG_ENDIAN |
| 48 | /* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ |
| 49 | uint8_t current:4, total:4; |
Ruben Undheim | 771a58f | 2015-12-09 20:22:42 +0100 | [diff] [blame] | 50 | #endif |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 51 | } page; |
| 52 | uint8_t data[0]; |
| 53 | } __attribute__((packed)); |
| 54 | |
Holger Hans Peter Freyther | 9c55914 | 2010-12-29 21:14:20 +0100 | [diff] [blame] | 55 | /* Chapter 9.4.1.3 */ |
| 56 | struct gsm341_etws_message { |
| 57 | struct { |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 58 | #if OSMO_IS_LITTLE_ENDIAN |
Holger Hans Peter Freyther | 9c55914 | 2010-12-29 21:14:20 +0100 | [diff] [blame] | 59 | uint8_t code_hi:4; |
| 60 | uint8_t popup:1; |
| 61 | uint8_t alert:1; |
| 62 | uint8_t gs:2; |
| 63 | uint8_t update:4; |
| 64 | uint8_t code_lo:4; |
Neels Hofmeyr | b260039 | 2018-11-16 00:20:39 +0100 | [diff] [blame] | 65 | #elif OSMO_IS_BIG_ENDIAN |
| 66 | /* auto-generated from the little endian part above (libosmocore/contrib/struct_endianess.py) */ |
| 67 | uint8_t gs:2, alert:1, popup:1, code_hi:4; |
| 68 | uint8_t code_lo:4, update:4; |
Ruben Undheim | 771a58f | 2015-12-09 20:22:42 +0100 | [diff] [blame] | 69 | #endif |
Holger Hans Peter Freyther | 9c55914 | 2010-12-29 21:14:20 +0100 | [diff] [blame] | 70 | } serial; |
| 71 | uint16_t msg_id; |
| 72 | uint16_t warning_type; |
| 73 | uint8_t data[0]; |
| 74 | } __attribute__((packed)); |
| 75 | |
Alex Badea | d126ab9 | 2011-01-15 19:43:42 +0200 | [diff] [blame] | 76 | #define GSM341_MSG_CODE(ms) ((ms)->serial.code_lo | ((ms)->serial.code_hi << 4)) |
Holger Hans Peter Freyther | e05c7df | 2010-12-29 11:57:48 +0100 | [diff] [blame] | 77 | |
Alex Badea | ab1246e | 2010-11-27 23:35:08 +0200 | [diff] [blame] | 78 | /* Section 9.3.2.1 - Geographical Scope */ |
| 79 | #define GSM341_GS_CELL_WIDE_IMMED 0 |
| 80 | #define GSM341_GS_PLMN_WIDE 1 |
| 81 | #define GSM341_GS_LA_WIDE 2 |
| 82 | #define GSM341_GS_CELL_WIDE 3 |
Harald Welte | a19717a | 2014-12-29 13:14:01 +0100 | [diff] [blame] | 83 | |
| 84 | /* Section 9.4.1.2.2 */ |
| 85 | #define GSM341_MSGID_EOTD_ASSISTANCE 0x03E8 |
| 86 | #define GSM341_MSGID_DGPS_CORRECTION 0x03E9 |
| 87 | #define GSM341_MSGID_DGPS_EPH_CLOCK_COR 0x03EA |
| 88 | #define GSM341_MSGID_GPS_ALMANAC_OTHER 0x03EB |
| 89 | #define GSM341_MSGID_ETWS_EARTHQUAKE 0x1100 |
| 90 | #define GSM341_MSGID_ETWS_TSUNAMI 0x1101 |
| 91 | #define GSM341_MSGID_ETWS_QUAKE_AND_TSUNAMI 0x1102 |
| 92 | #define GSM341_MSGID_ETWS_TEST 0x1103 |
| 93 | #define GSM341_MSGID_ETWS_OTHER 0x1104 |
| 94 | #define GSM341_MSGID_ETWS_CMAS_PRESIDENTIAL 0x1112 |
| 95 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_IMM_OBSERVED 0x1113 |
| 96 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_IMM_LIKELY 0x1114 |
| 97 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_EXP_OBSERVED 0x1115 |
| 98 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_EXP_LIKELY 0x1116 |
| 99 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_IMM_OBSERVED 0x1117 |
| 100 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_IMM_LIKELY 0x1118 |
| 101 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_EXP_OBSERVED 0x1119 |
| 102 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_EXP_LIKELY 0x111A |
| 103 | #define GSM341_MSGID_ETWS_CMAS_AMBER 0x111B |
| 104 | #define GSM341_MSGID_ETWS_CMAS_MONTHLY_TEST 0x111C |
| 105 | #define GSM341_MSGID_ETWS_CMAS_EXERCISE 0x111D |
| 106 | #define GSM341_MSGID_ETWS_CMAS_OPERATOR_DEFINED 0x111E |
| 107 | #define GSM341_MSGID_ETWS_CMAS_PRESIDENTIAL_AL 0x111F |
| 108 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_IMM_OBSERVED_AL 0x1120 |
| 109 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_IMM_LIKELY_AL 0x1121 |
| 110 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_EXP_OBSERVED_AL 0x1122 |
| 111 | #define GSM341_MSGID_ETWS_CMAS_EXTREME_EXP_LIKELY_AL 0x1123 |
| 112 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_IMM_OBSERVED_AL 0x1124 |
| 113 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_IMM_LIKELY_AL 0x1125 |
| 114 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_EXP_OBSERVED_AL 0x1126 |
| 115 | #define GSM341_MSGID_ETWS_CMAS_SEVERE_EXP_LIKELY_AL 0x1127 |
| 116 | #define GSM341_MSGID_ETWS_CMAS_AMBER_AL 0x1128 |
| 117 | #define GSM341_MSGID_ETWS_CMAS_MONTHLY_TEST_AL 0x1129 |
| 118 | #define GSM341_MSGID_ETWS_CMAS_EXERCISE_AL 0x112A |
| 119 | #define GSM341_MSGID_ETWS_CMAS_OPERATOR_DEFINED_AL 0x112B |
| 120 | #define GSM341_MSGID_ETWS_EU_INFO_LOCAL_LANGUAGE 0x1900 |