7 A Linux/Unix toolset and driver for Nokia mobile phones.
9 Copyright (C) 2001 Pawe³ Kot <pkot@linuxnews.pl>
11 Released under the terms of the GNU GPL, see file COPYING for more details.
13 Library for parsing and creating Short Messages (SMS).
16 Revision 1.1.1.1.2.1 2001/11/27 22:48:37 short
17 Update: orig2001_11_27_05_17 -> orig2001_11_27_22_58
19 Revision 1.1.1.2 2001/11/27 22:01:13 short
20 :pserver:cvs@pserver.samba.org:/cvsroot - gnokii - Tue Nov 27 22:58 CET 2001
22 Revision 1.14 2001/11/27 12:19:00 pkot
23 Cleanup, indentation, ANSI complaint preprocesor symbols (Jan Kratochvil, me)
25 Revision 1.13 2001/11/23 22:07:44 machek
26 Fix SMS receiving to work, again. Unfortunately, it is not possible to
27 reuse much of gsm-sms.c...
29 Revision 1.12 2001/11/22 17:56:53 pkot
30 smslib update. sms sending
32 Revision 1.11 2001/11/20 16:22:22 pkot
33 First attempt to read Picture Messages. They should appear when you enable DEBUG. Nokia seems to break own standards. :/ (Markus Plail)
35 Revision 1.10 2001/11/19 13:09:40 pkot
36 Begin work on sms sending
38 Revision 1.9 2001/11/18 00:54:32 pkot
39 Bugfixes. I18n of the user responses. UDH support in libsms. Business Card UDH Type
41 Revision 1.8 2001/11/17 20:19:29 pkot
42 smslib cleanups, fixes and debugging
44 Revision 1.7 2001/11/15 12:15:04 pkot
45 smslib updates. begin work on sms in 6100 series
47 Revision 1.6 2001/11/14 18:21:19 pkot
48 Fixing some problems with UDH and Unicode, but still doesn't work yet :-(
50 Revision 1.5 2001/11/14 14:26:18 pkot
51 Changed offset of DCS field to the right value in 6210/7110
53 Revision 1.4 2001/11/14 11:26:18 pkot
54 Getting SMS in 6210/7110 does finally work in some cases :)
56 Revision 1.3 2001/11/13 16:12:20 pkot
57 Preparing libsms to get to work. 6210/7110 SMS and SMS Folder updates
59 Revision 1.2 2001/11/09 14:25:04 pkot
62 Revision 1.1 2001/11/08 16:23:21 pkot
63 New version of libsms. Not functional yet, but it reasonably stable API.
65 Revision 1.1 2001/07/09 23:06:26 pkot
66 Moved sms.* files from my hard disk to CVS
73 #include "gsm-common.h"
74 #include "gsm-encoding.h"
75 #include "gsm-bitmaps.h"
82 /* Number of header specific octets in SMS header (before data) */
83 static unsigned short DataOffset[] = {
85 3, /* SMS Deliver Report */
87 3, /* SMS Submit Report */
89 3 /* SMS Status Report */
92 /* User data headers */
93 static struct udh_data headers[] = {
95 { 0x05, "\x00\x03\x01\x00\x00" }, /* Concatenated messages */
96 { 0x06, "\x05\x04\x15\x82\x00\x00" }, /* Operator logos */
97 { 0x06, "\x05\x04\x15\x83\x00\x00" }, /* Caller logos */
98 { 0x06, "\x05\x04\x15\x81\x00\x00" }, /* Ringtones */
99 { 0x04, "\x03\x01\x00\x00" }, /* Voice Messages */
100 { 0x04, "\x03\x01\x01\x00" }, /* Fax Messages */
101 { 0x04, "\x03\x01\x02\x00" }, /* Email Messages */
102 { 0x06, "\x05\x04\x23\xf4\x00\x00" }, /* Business Card */
111 /* This function implements packing of numbers (SMS Center number and
112 destination number) for SMS sending function. */
113 static int SemiOctetPack(char *Number, unsigned char *Output, SMS_NumberType type)
115 unsigned char *IN = Number; /* Pointer to the input number */
116 unsigned char *OUT = Output; /* Pointer to the output */
117 int count = 0; /* This variable is used to notify us about count of already
120 /* The first byte in the Semi-octet representation of the address field is
121 the Type-of-Address. This field is described in the official GSM
122 specification 03.40 version 6.1.0, section 9.1.2.5, page 33. We support
123 only international and unknown number. */
126 if (type == SMS_International) IN++; /* Skip '+' */
127 if ((type == SMS_Unknown) && (*IN == '+')) IN++; /* Optional '+' in Unknown number type */
129 /* The next field is the number. It is in semi-octet representation - see
130 GSM scpecification 03.40 version 6.1.0, section 9.1.2.3, page 31. */
133 *OUT = *OUT | ((*IN - '0') << 4);
141 /* We should also fill in the most significant bits of the last byte with
142 0x0f (1111 binary) if the number is represented with odd number of
149 return (2 * (OUT - Output - 1) - (count % 2));
152 char *GetBCDNumber(u8 *Number)
154 static char Buffer[20] = "";
155 int length = Number[0]; /* This is the length of BCD coded number */
158 memset(Buffer, 0, 20);
160 case SMS_Alphanumeric:
161 Unpack7BitCharacters(0, length, length, Number+2, Buffer);
164 case SMS_International:
165 sprintf(Buffer, "+");
170 case SMS_Abbreviated:
172 for (count = 0; count < length - 1; count++) {
173 Digit = Number[count+2] & 0x0f;
174 if (Digit < 10) sprintf(Buffer, "%s%d", Buffer, Digit);
175 Digit = Number[count+2] >> 4;
176 if (Digit < 10) sprintf(Buffer, "%s%d", Buffer, Digit);
183 static char *PrintDateTime(u8 *Number)
185 static char Buffer[23] = "";
187 memset(Buffer, 0, 23);
188 if (Number[0] < 70) sprintf(Buffer, "20");
189 else sprintf(Buffer, "19");
190 sprintf(Buffer, "%s%d%d-", Buffer, Number[0] & 0x0f, Number[0] >> 4);
191 sprintf(Buffer, "%s%d%d-", Buffer, Number[1] & 0x0f, Number[1] >> 4);
192 sprintf(Buffer, "%s%d%d ", Buffer, Number[2] & 0x0f, Number[2] >> 4);
193 sprintf(Buffer, "%s%d%d:", Buffer, Number[3] & 0x0f, Number[3] >> 4);
194 sprintf(Buffer, "%s%d%d:", Buffer, Number[4] & 0x0f, Number[4] >> 4);
195 sprintf(Buffer, "%s%d%d", Buffer, Number[5] & 0x0f, Number[5] >> 4);
196 if (Number[6] & 0x08)
197 sprintf(Buffer, "%s-", Buffer);
199 sprintf(Buffer, "%s+", Buffer);
200 sprintf(Buffer, "%s%02d00", Buffer, (10 * (Number[6] & 0x07) + (Number[6] >> 4)) / 4);
205 SMS_DateTime *UnpackDateTime(u8 *Number, SMS_DateTime *dt)
207 dt->Year = 10 * (Number[0] & 0x0f) + (Number[0] >> 4);
208 if (dt->Year < 70) dt->Year += 2000;
209 else dt->Year += 1900;
210 dt->Month = 10 * (Number[1] & 0x0f) + (Number[1] >> 4);
211 dt->Day = 10 * (Number[2] & 0x0f) + (Number[2] >> 4);
212 dt->Hour = 10 * (Number[3] & 0x0f) + (Number[3] >> 4);
213 dt->Minute = 10 * (Number[4] & 0x0f) + (Number[4] >> 4);
214 dt->Second = 10 * (Number[5] & 0x0f) + (Number[5] >> 4);
215 dt->Timezone = (10 * (Number[6] & 0x07) + (Number[6] >> 4)) / 4;
216 if (Number[6] & 0x08) dt->Timezone = -dt->Timezone;
225 static GSM_Error EncodeData(GSM_SMSMessage *SMS, char *dcs, char *message)
228 unsigned short length = strlen(SMS->MessageText);
230 switch (SMS->DCS.Type) {
231 case SMS_GeneralDataCoding:
232 switch (SMS->DCS.u.General.Class) {
233 case 1: dcs[0] |= 0xf0; break;
234 case 2: dcs[0] |= 0xf1; break;
235 case 3: dcs[0] |= 0xf2; break;
236 case 4: dcs[0] |= 0xf3; break;
239 if (SMS->DCS.u.General.Compressed) {
240 /* Compression not supported yet */
241 /* dcs[0] |= 0x20; */
243 al = SMS->DCS.u.General.Alphabet;
245 case SMS_MessageWaiting:
246 al = SMS->DCS.u.MessageWaiting.Alphabet;
247 if (SMS->DCS.u.MessageWaiting.Discard) dcs[0] |= 0xc0;
248 else if (SMS->DCS.u.MessageWaiting.Alphabet == SMS_UCS2) dcs[0] |= 0xe0;
251 if (SMS->DCS.u.MessageWaiting.Active) dcs[0] |= 0x08;
252 dcs[0] |= (SMS->DCS.u.MessageWaiting.Type & 0x03);
256 return GE_SMSWRONGFORMAT;
259 case SMS_DefaultAlphabet:
260 Pack7BitCharacters((7 - (SMS->UDH_Length % 7)) % 7, SMS->MessageText, message);
261 SMS->Length = 8 * SMS->UDH_Length + (7 - (SMS->UDH_Length % 7)) % 7 + length;
265 memcpy(message, SMS->MessageText + 1, SMS->MessageText[0]);
266 SMS->Length = SMS->UDH_Length + SMS->MessageText[0];
270 EncodeUnicode(message, SMS->MessageText, length);
271 SMS->Length = length;
274 return GE_SMSWRONGFORMAT;
279 /* This function encodes the UserDataHeader as described in:
280 - GSM 03.40 version 6.1.0 Release 1997, section 9.2.3.24
281 - Smart Messaging Specification, Revision 1.0.0, September 15, 1997
283 static GSM_Error EncodeUDH(SMS_UDHInfo UDHi, char *UDH)
291 case SMS_VoiceMessage:
293 case SMS_EmailMessage:
294 UDH[pos+4] = UDHi.u.SpecialSMSMessageIndication.MessageCount;
295 if (UDHi.u.SpecialSMSMessageIndication.Store) UDH[pos+3] |= 0x80;
296 case SMS_ConcatenatedMessages:
298 case SMS_CallerIDLogo:
300 UDH[0] += headers[UDHi.Type].length;
301 memcpy(UDH+pos+1, headers[UDHi.Type].header, headers[UDHi.Type].length);
304 dprintf("Not supported User Data Header type\n");
310 static GSM_Error EncodeSMSSubmitHeader(GSM_SMSMessage *SMS, char *frame)
312 GSM_Error error = GE_NONE;
314 /* Standard Header: */
315 memcpy(frame, "\x11\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xa9\x00\x00\x00\x00\x00\x00", 24);
318 if (SMS->ReplyViaSameSMSC) frame[0] |= 0x80;
320 /* User Data Header Indicator */
321 if (SMS->UDH_No) frame[0] |= 0x40;
323 /* Status (Delivery) Report Request */
324 if (SMS->ReportStatus) frame[0] |= 0x20;
326 /* Validity Period Format: mask - 0x00, 0x10, 0x08, 0x18 */
327 frame[0] |= ((SMS->Validity.VPF & 0x03) << 3);
329 /* Reject Duplicates */
330 if (SMS->RejectDuplicates) frame[0] |= 0x04;
332 /* Message Type is already set */
334 /* Message Reference */
335 /* Can we set this? */
337 /* Protocol Identifier */
338 /* FIXME: allow to change this in better way.
339 currently only 0x5f == `Return Call Message' is used */
340 if (SMS->PID) frame[3] = SMS->PID;
342 /* Data Coding Scheme */
343 switch (SMS->DCS.Type) {
344 case SMS_GeneralDataCoding:
345 if (SMS->DCS.u.General.Compressed) frame[4] |= 0x20;
346 if (SMS->DCS.u.General.Class) frame[4] |= (0x10 | (SMS->DCS.u.General.Class - 1));
347 frame[4] |= ((SMS->DCS.u.General.Alphabet & 0x03) << 2);
349 case SMS_MessageWaiting:
350 if (SMS->DCS.u.MessageWaiting.Discard) frame[4] |= 0xc0;
351 else if (SMS->DCS.u.MessageWaiting.Alphabet == SMS_UCS2) frame[4] |= 0xe0;
352 else frame[4] |= 0xd0;
353 if (SMS->DCS.u.MessageWaiting.Active) frame[4] |= 0x80;
354 frame[4] |= (SMS->DCS.u.MessageWaiting.Type & 0x03);
357 dprintf("Wrong Data Coding Scheme (DCS) format\n");
358 return GE_SMSWRONGFORMAT;
361 /* Destination Address */
362 frame[5] = SemiOctetPack(SMS->RemoteNumber.number, frame + 6, SMS->RemoteNumber.type);
364 /* Validity Period */
365 switch (SMS->Validity.VPF) {
366 case SMS_EnhancedFormat:
368 case SMS_RelativeFormat:
370 case SMS_AbsoluteFormat:
379 static GSM_Error EncodeSMSDeliverHeader()
384 static GSM_Error EncodeSMSHeader(GSM_SMSMessage *SMS, char *frame)
385 /* We can create either SMS DELIVER (for saving in Inbox) or SMS SUBMIT
386 (for sending or saving in Outbox) message */
389 frame[12] |= (SMS->Type >> 1);
391 case SMS_Submit: /* we send SMS or save it in Outbox */
392 return EncodeSMSSubmitHeader(SMS, frame);
393 case SMS_Deliver: /* we save SMS in Inbox */
394 return EncodeSMSDeliverHeader(SMS, frame);
395 default: /* we don't create other formats of SMS */
396 return GE_SMSWRONGFORMAT;
400 /* This function encodes SMS as described in:
401 - GSM 03.40 version 6.1.0 Release 1997, section 9
403 int EncodePDUSMS(GSM_SMSMessage *SMS, char *message)
405 GSM_Error error = GE_NONE;
408 dprintf("Sending SMS to %s via message center %s\n", SMS->RemoteNumber.number, SMS->MessageCenter.Number);
411 dprintf("%d %s\n", SMS->MessageCenter.Type, SMS->MessageCenter.Number);
412 message[0] = SemiOctetPack(SMS->MessageCenter.Number, message + 1, SMS->MessageCenter.Type);
413 if (message[0] % 2) message[0]++;
414 message[0] = message[0] / 2 + 1;
417 error = EncodeSMSHeader(SMS, message + 12);
418 if (error != GE_NONE) return error;
420 /* User Data Header - if present */
421 // for (i = 0; i < SMS->UDH_No; i++) {
422 // error = EncodeUDH(SMS->UDH[i], message + 24);
423 // if (error != GE_NONE) return error;
428 EncodeData(SMS, message + 14, message + 36 + SMS->UDH_Length);
429 message[16] = SMS->Length;
430 return SMS->Length + 35;
433 /* This function does simple SMS encoding - no PDU coding */
434 GSM_Error EncodeTextSMS()
443 static GSM_Error SMSStatus(unsigned char status, GSM_SMSMessage *SMS)
446 strcpy(SMS->MessageText, _("Delivered"));
449 dprintf("SM received by the SME");
452 dprintf("SM forwarded by the SC to the SME but the SC is unable to confirm delivery");
455 dprintf("SM replaced by the SC");
458 SMS->Length = strlen(_("Delivered"));
459 } else if (status & 0x40) {
461 strcpy(SMS->MessageText, _("Failed"));
463 /* more detailed reason only for debug */
466 dprintf("Temporary error, SC is not making any more transfer attempts\n");
470 dprintf("Congestion");
476 dprintf("No response from SME");
479 dprintf("Service rejected");
482 dprintf("Quality of service not aviable");
485 dprintf("Error in SME");
488 dprintf("Reserved/Specific to SC: %x", status);
492 dprintf("Permanent error, SC is not making any more transfer attempts\n");
495 dprintf("Remote procedure error");
498 dprintf("Incompatibile destination");
501 dprintf("Connection rejected by SME");
504 dprintf("Not obtainable");
507 dprintf("Quality of service not aviable");
510 dprintf("No internetworking available");
513 dprintf("SM Validity Period Expired");
516 dprintf("SM deleted by originating SME");
519 dprintf("SM Deleted by SC Administration");
522 dprintf("SM does not exist");
525 dprintf("Reserved/Specific to SC: %x", status);
529 SMS->Length = strlen(_("Failed"));
530 } else if (status & 0x20) {
531 strcpy(SMS->MessageText, _("Pending"));
533 /* more detailed reason only for debug */
534 dprintf("Temporary error, SC still trying to transfer SM\n");
537 dprintf("Congestion");
543 dprintf("No response from SME");
546 dprintf("Service rejected");
549 dprintf("Quality of service not aviable");
552 dprintf("Error in SME");
555 dprintf("Reserved/Specific to SC: %x", status);
558 SMS->Length = strlen(_("Pending"));
560 strcpy(SMS->MessageText, _("Unknown"));
562 /* more detailed reason only for debug */
563 dprintf("Reserved/Specific to SC: %x", status);
564 SMS->Length = strlen(_("Unknown"));
570 static GSM_Error DecodeData(char *message, char *output, int length, int size, int udhlen, SMS_DataCodingScheme dcs)
573 if ((dcs.Type & 0x08) == 0x08) {
574 dprintf("Unicode message\n");
575 length = (length - udhlen)/2;
576 DecodeUnicode(output, message, length);
579 if ((dcs.Type & 0xf4) == 0xf4) {
580 dprintf("8bit message\n");
581 memcpy(output, message, length);
584 dprintf("Default Alphabet\n");
585 length = length - (udhlen * 8 + ((7-(udhlen%7))%7)) / 7;
586 Unpack7BitCharacters((7-udhlen)%7, size, length, message, output);
587 DecodeAscii(output, output, length);
590 dprintf("%s\n", output);
594 /* This function decodes UDH as described in:
595 - GSM 03.40 version 6.1.0 Release 1997, section 9.2.3.24
596 - Smart Messaging Specification, Revision 1.0.0, September 15, 1997
598 static GSM_Error DecodeUDH(char *message, GSM_SMSMessage *SMS)
600 unsigned char length, pos, nr;
602 SMS->UDH_Length = length = message[0] + 1;
606 unsigned char udh_length;
608 udh_length = message[pos+1];
609 switch (message[pos]) {
610 case 0x00: // Concatenated short messages
611 dprintf("Concatenated messages\n");
612 SMS->UDH[nr].Type = SMS_ConcatenatedMessages;
613 SMS->UDH[nr].u.ConcatenatedShortMessage.ReferenceNumber = message[pos + 2];
614 SMS->UDH[nr].u.ConcatenatedShortMessage.MaximumNumber = message[pos + 3];
615 SMS->UDH[nr].u.ConcatenatedShortMessage.CurrentNumber = message[pos + 4];
617 case 0x01: // Special SMS Message Indication
618 switch (message[pos + 2] & 0x03) {
620 dprintf("Voice Message\n");
621 SMS->UDH[nr].Type = SMS_VoiceMessage;
624 dprintf("Fax Message\n");
625 SMS->UDH[nr].Type = SMS_FaxMessage;
628 dprintf("Email Message\n");
629 SMS->UDH[nr].Type = SMS_EmailMessage;
632 dprintf("Unknown\n");
633 SMS->UDH[nr].Type = SMS_UnknownUDH;
636 SMS->UDH[nr].u.SpecialSMSMessageIndication.Store = (message[pos + 2] & 0x80) >> 7;
637 SMS->UDH[nr].u.SpecialSMSMessageIndication.MessageCount = message[pos + 3];
639 case 0x04: // Application port addression scheme, 8 bit address
641 case 0x05: // Application port addression scheme, 16 bit address
642 switch (((0x00ff & message[pos + 2]) << 8) | (0x00ff & message[pos + 3])) {
644 dprintf("Ringtone\n");
645 SMS->UDH[nr].Type = SMS_Ringtone;
648 dprintf("Operator Logo\n");
649 SMS->UDH[nr].Type = SMS_OpLogo;
652 dprintf("Caller Icon\n");
653 SMS->UDH[nr].Type = SMS_CallerIDLogo;
656 dprintf("Business Card\n");
657 SMS->UDH[nr].Type = SMS_BusinessCard;
660 dprintf("Unknown\n");
661 SMS->UDH[nr].Type = SMS_UnknownUDH;
665 case 0x06: // SMSC Control Parameters
667 case 0x07: // UDH Source Indicator
672 length -= (udh_length + 2);
673 pos += (udh_length + 2);
681 static GSM_Error DecodeSMSHeader(unsigned char *message, GSM_SMSMessage *SMS)
683 /* Short Message Type */
684 switch (SMS->Type = message[2]) {
686 dprintf("Mobile Terminated message:\n");
688 case SMS_Delivery_Report:
689 dprintf("Delivery Report:\n");
690 UnpackDateTime(message + 34 + DataOffset[SMS->Type], &(SMS->SMSCTime));
691 dprintf("\tDelivery date: %s\n", PrintDateTime(message + 34 + DataOffset[SMS->Type]));
694 dprintf("Mobile Originated message:\n");
697 dprintf("Not supported message type:\n");
701 /* Short Message location in memory */
702 SMS->Number = message[1];
703 dprintf("\tLocation: %d\n", SMS->Number);
705 /* Short Message Center */
706 strcpy(SMS->MessageCenter.Number, GetBCDNumber(message + 3));
707 dprintf("\tSMS center number: %s\n", SMS->MessageCenter.Number);
708 SMS->ReplyViaSameSMSC = false;
709 if (SMS->RemoteNumber.number[0] == 0 && (message[6] & 0x80)) {
710 SMS->ReplyViaSameSMSC = true;
714 message[15+DataOffset[SMS->Type]] = ((message[15+DataOffset[SMS->Type]])+1)/2+1;
715 dprintf("\tRemote number (recipient or sender): %s\n", GetBCDNumber(message + 15 + DataOffset[SMS->Type]));
716 strcpy(SMS->RemoteNumber.number, GetBCDNumber(message + 15 + DataOffset[SMS->Type]));
718 UnpackDateTime(message + 27 + DataOffset[SMS->Type], &(SMS->Time));
719 dprintf("\tDate: %s\n", PrintDateTime(message + 27 + DataOffset[SMS->Type]));
722 SMS->Length = message[14+DataOffset[SMS->Type]];
724 /* Data Coding Scheme */
725 if (SMS->Type != SMS_Delivery_Report && SMS->Type != SMS_Picture)
726 SMS->DCS.Type = message[13 + DataOffset[SMS->Type]];
730 /* User Data Header */
731 if (message[15] & 0x40) { /* UDH header available */
732 dprintf("UDH found\n");
733 DecodeUDH(message + 34 + DataOffset[SMS->Type], SMS);
734 } else { /* No UDH */
742 /* This function decodes SMS as described in:
743 - GSM 03.40 version 6.1.0 Release 1997, section 9
745 GSM_Error DecodePDUSMS(unsigned char *message, GSM_SMSMessage *SMS, int MessageLength)
750 DecodeSMSHeader(message, SMS);
752 case SMS_Delivery_Report:
753 SMSStatus(message[17], SMS);
756 dprintf("Picture!!!\n");
757 GSM_ReadSMSBitmap(SMS_Picture, message + 41, NULL, &bitmap);
758 GSM_PrintBitmap(&bitmap);
759 size = MessageLength - 45 - bitmap.size;
760 SMS->Length = message[45 + bitmap.size];
761 printf("%d %d %d\n", SMS->Length, bitmap.size, size);
762 DecodeData(message + 46 + bitmap.size,
763 (unsigned char *)&(SMS->MessageText),
764 SMS->Length, size, 0, SMS->DCS);
765 SMS->MessageText[SMS->Length] = 0;
768 size = MessageLength -
769 34 - /* Header Length */
770 DataOffset[SMS->Type] - /* offset */
771 SMS->UDH_Length - /* UDH Length */
773 DecodeData(message + 34 + DataOffset[SMS->Type] + SMS->UDH_Length,
774 (unsigned char *)&(SMS->MessageText),
775 SMS->Length, size, SMS->UDH_Length, SMS->DCS);
777 SMS->MessageText[SMS->Length] = 0;
784 /* This function does simple SMS decoding - no PDU coding */
785 GSM_Error DecodeTextSMS(unsigned char *message, GSM_SMSMessage *SMS)