cellular-infrastructure
/
osmo-cbc
mirror of https://gerrit.osmocom.org/osmo-cbc
9
0
Fork 0
Code Issues Releases Wiki Activity
osmo-cbc/include/osmocom/sbcap/sbcap_common.h

159 lines
7.7 KiB
C
Raw Normal View History

Add sbcap library This commit adds initial support to encode/decode SBc-AP messages in the form of a library, under src/sbcap/ (includes in include/osmocom/sbcap/). asn1c is used to generate all suport code and structures for ASN.1 APER encoding/decoding, based on asn files obtained from 3GPP TS 29.168 and stored under src/sbcap/asn1/. Currently, mainstream asn1c doesn't yet support ASN.1 APER encoding/decoding, hence mouse07410 's fork is used [1]. Furthermore, several encdoing/decoding bugs where found during the process and fixed, which means asn1.c git >= 30219de2d3da888b4f1eea0dd79f2a505000401a must be used to generate proper code. A new "make -C src/ gen" target is added which can be used to regenerate all C code from the available ASN.1 files in src/sbcap/asn1/*.asn (after properly setting configure.ac ASN_* variables if needed). [1] https://github.com/mouse07410/asn1c Related: OS#4945 Change-Id: If76f8619a9b2d46af6d94b8ae49348b8514e53aa
2022-07-13 15:27:15 +00:00
#pragma once
#include <asn_application.h>
#include <osmocom/sbcap/SBcAP_Broadcast-Cancelled-Area-List-5GS.h>
#include <osmocom/sbcap/SBcAP_Broadcast-Cancelled-Area-List.h>
#include <osmocom/sbcap/SBcAP_Broadcast-Empty-Area-List-5GS.h>
#include <osmocom/sbcap/SBcAP_Broadcast-Empty-Area-List.h>
#include <osmocom/sbcap/SBcAP_Broadcast-Scheduled-Area-List-5GS.h>
#include <osmocom/sbcap/SBcAP_Broadcast-Scheduled-Area-List.h>
#include <osmocom/sbcap/SBcAP_CancelledCellinEAI.h>
#include <osmocom/sbcap/SBcAP_CancelledCellinEAI-Item.h>
#include <osmocom/sbcap/SBcAP_CancelledCellinTAI-5GS.h>
#include <osmocom/sbcap/SBcAP_CancelledCellinTAI.h>
#include <osmocom/sbcap/SBcAP_CancelledCellinTAI-Item.h>
#include <osmocom/sbcap/SBcAP_Cause.h>
#include <osmocom/sbcap/SBcAP_CellId-Broadcast-List-5GS.h>
#include <osmocom/sbcap/SBcAP_CellId-Broadcast-List.h>
#include <osmocom/sbcap/SBcAP_CellId-Broadcast-List-Item.h>
#include <osmocom/sbcap/SBcAP_CellID-Cancelled-Item.h>
#include <osmocom/sbcap/SBcAP_CellID-Cancelled-List-5GS.h>
#include <osmocom/sbcap/SBcAP_CellID-Cancelled-List.h>
#include <osmocom/sbcap/SBcAP_CellIdentity.h>
#include <osmocom/sbcap/SBcAP_Concurrent-Warning-Message-Indicator.h>
#include <osmocom/sbcap/SBcAP_Criticality-Diagnostics.h>
#include <osmocom/sbcap/SBcAP_CriticalityDiagnostics-IE-List.h>
#include <osmocom/sbcap/SBcAP_Criticality.h>
#include <osmocom/sbcap/SBcAP_Data-Coding-Scheme.h>
#include <osmocom/sbcap/SBcAP_ECGIList.h>
#include <osmocom/sbcap/SBcAP_EmergencyAreaID-Broadcast-List.h>
#include <osmocom/sbcap/SBcAP_EmergencyAreaID-Broadcast-List-Item.h>
#include <osmocom/sbcap/SBcAP_EmergencyAreaID-Cancelled-Item.h>
#include <osmocom/sbcap/SBcAP_EmergencyAreaID-Cancelled-List.h>
#include <osmocom/sbcap/SBcAP_Emergency-Area-ID.h>
#include <osmocom/sbcap/SBcAP_Emergency-Area-ID-List.h>
#include <osmocom/sbcap/SBcAP_ENB-ID.h>
#include <osmocom/sbcap/SBcAP_Error-Indication.h>
#include <osmocom/sbcap/SBcAP_EUTRAN-CGI.h>
#include <osmocom/sbcap/SBcAP_Extended-Repetition-Period.h>
#include <osmocom/sbcap/SBcAP_Failed-Cell-List.h>
#include <osmocom/sbcap/SBcAP_Failed-Cell-List-NR.h>
#include <osmocom/sbcap/SBcAP_Global-ENB-ID.h>
#include <osmocom/sbcap/SBcAP_Global-GNB-ID.h>
#include <osmocom/sbcap/SBcAP_Global-NgENB-ID.h>
#include <osmocom/sbcap/SBcAP_Global-RAN-Node-ID.h>
#include <osmocom/sbcap/SBcAP_GNB-ID.h>
#include <osmocom/sbcap/SBcAP_InitiatingMessage.h>
#include <osmocom/sbcap/SBcAP_List-of-5GS-Cells-for-Failure.h>
#include <osmocom/sbcap/SBcAP_List-of-5GS-TAI-for-Restart.h>
#include <osmocom/sbcap/SBcAP_List-of-5GS-TAIs.h>
#include <osmocom/sbcap/SBcAP_List-of-EAIs-Restart.h>
#include <osmocom/sbcap/SBcAP_List-of-TAIs.h>
#include <osmocom/sbcap/SBcAP_List-of-TAIs-Restart.h>
#include <osmocom/sbcap/SBcAP_Message-Identifier.h>
#include <osmocom/sbcap/SBcAP_NgENB-ID.h>
#include <osmocom/sbcap/SBcAP_NRCellIdentity.h>
#include <osmocom/sbcap/SBcAP_NR-CGI.h>
#include <osmocom/sbcap/SBcAP_NR-CGIList.h>
#include <osmocom/sbcap/SBcAP_NumberOfBroadcasts.h>
#include <osmocom/sbcap/SBcAP_Number-of-Broadcasts-Requested.h>
#include <osmocom/sbcap/SBcAP_Omc-Id.h>
#include <osmocom/sbcap/SBcAP_PLMNidentity.h>
#include <osmocom/sbcap/SBcAP_Presence.h>
#include <osmocom/sbcap/SBcAP_ProcedureCode.h>
#include <osmocom/sbcap/SBcAP_ProtocolExtensionContainer.h>
#include <osmocom/sbcap/SBcAP_ProtocolExtensionField.h>
#include <osmocom/sbcap/SBcAP_ProtocolExtensionID.h>
#include <osmocom/sbcap/SBcAP_ProtocolIE-Container.h>
#include <osmocom/sbcap/SBcAP_ProtocolIE-ContainerList.h>
#include <osmocom/sbcap/SBcAP_ProtocolIE-Field.h>
#include <osmocom/sbcap/SBcAP_ProtocolIE-ID.h>
#include <osmocom/sbcap/SBcAP_PWS-Failure-Indication.h>
#include <osmocom/sbcap/SBcAP_PWS-Restart-Indication.h>
#include <osmocom/sbcap/SBcAP_RAT-Selector-5GS.h>
#include <osmocom/sbcap/SBcAP_Repetition-Period.h>
#include <osmocom/sbcap/SBcAP_Restarted-Cell-List.h>
#include <osmocom/sbcap/SBcAP_Restarted-Cell-List-NR.h>
#include <osmocom/sbcap/SBcAP_SBC-AP-PDU.h>
#include <osmocom/sbcap/SBcAP_ScheduledCellinEAI.h>
#include <osmocom/sbcap/SBcAP_ScheduledCellinEAI-Item.h>
#include <osmocom/sbcap/SBcAP_ScheduledCellinTAI-5GS.h>
#include <osmocom/sbcap/SBcAP_ScheduledCellinTAI.h>
#include <osmocom/sbcap/SBcAP_ScheduledCellinTAI-Item.h>
#include <osmocom/sbcap/SBcAP_Send-Stop-Warning-Indication.h>
#include <osmocom/sbcap/SBcAP_Send-Write-Replace-Warning-Indication.h>
#include <osmocom/sbcap/SBcAP_Serial-Number.h>
#include <osmocom/sbcap/SBcAP_Stop-All-Indicator.h>
#include <osmocom/sbcap/SBcAP_Stop-Warning-Indication.h>
#include <osmocom/sbcap/SBcAP_Stop-Warning-Request.h>
#include <osmocom/sbcap/SBcAP_Stop-Warning-Response.h>
#include <osmocom/sbcap/SBcAP_SuccessfulOutcome.h>
#include <osmocom/sbcap/SBcAP_TAC-5GS.h>
#include <osmocom/sbcap/SBcAP_TAC.h>
#include <osmocom/sbcap/SBcAP_TAI-5GS.h>
#include <osmocom/sbcap/SBcAP_TAI-Broadcast-List-5GS.h>
#include <osmocom/sbcap/SBcAP_TAI-Broadcast-List.h>
#include <osmocom/sbcap/SBcAP_TAI-Broadcast-List-Item.h>
#include <osmocom/sbcap/SBcAP_TAI-Cancelled-List-5GS.h>
#include <osmocom/sbcap/SBcAP_TAI-Cancelled-List.h>
#include <osmocom/sbcap/SBcAP_TAI-Cancelled-List-Item.h>
#include <osmocom/sbcap/SBcAP_TAI.h>
#include <osmocom/sbcap/SBcAP_TAI-List-for-Warning.h>
#include <osmocom/sbcap/SBcAP_TBCD-STRING.h>
#include <osmocom/sbcap/SBcAP_TriggeringMessage.h>
#include <osmocom/sbcap/SBcAP_TypeOfError.h>
#include <osmocom/sbcap/SBcAP_Unknown-5GS-Tracking-Area-List.h>
#include <osmocom/sbcap/SBcAP_Unknown-Tracking-Area-List.h>
#include <osmocom/sbcap/SBcAP_UnsuccessfulOutcome.h>
#include <osmocom/sbcap/SBcAP_Warning-Area-Coordinates.h>
#include <osmocom/sbcap/SBcAP_Warning-Area-List-5GS.h>
#include <osmocom/sbcap/SBcAP_Warning-Area-List.h>
#include <osmocom/sbcap/SBcAP_Warning-Message-Content.h>
#include <osmocom/sbcap/SBcAP_Warning-Security-Information.h>
#include <osmocom/sbcap/SBcAP_Warning-Type.h>
#include <osmocom/sbcap/SBcAP_Write-Replace-Warning-Indication.h>
#include <osmocom/sbcap/SBcAP_Write-Replace-Warning-Request.h>
#include <osmocom/sbcap/SBcAP_Write-Replace-Warning-Response.h>
#include <osmocom/core/logging.h>
Move ASN1C enc/dec logging to its own category ASN1C encoding/decoding can get really verbose. Furthermore, it should only be enabled under really specific conditions, so it makes sense to have it under its own category. Change-Id: Ia4cbae2395532d9b5b7b9177a7d0f31bf777d751
2022-07-27 15:58:10 +00:00
extern int _sbcap_DASN1C;
#define SBC_AP_DEBUG(x, args ...) DEBUGP(_sbcap_DASN1C, x, ## args)
Add sbcap library This commit adds initial support to encode/decode SBc-AP messages in the form of a library, under src/sbcap/ (includes in include/osmocom/sbcap/). asn1c is used to generate all suport code and structures for ASN.1 APER encoding/decoding, based on asn files obtained from 3GPP TS 29.168 and stored under src/sbcap/asn1/. Currently, mainstream asn1c doesn't yet support ASN.1 APER encoding/decoding, hence mouse07410 's fork is used [1]. Furthermore, several encdoing/decoding bugs where found during the process and fixed, which means asn1.c git >= 30219de2d3da888b4f1eea0dd79f2a505000401a must be used to generate proper code. A new "make -C src/ gen" target is added which can be used to regenerate all C code from the available ASN.1 files in src/sbcap/asn1/*.asn (after properly setting configure.ac ASN_* variables if needed). [1] https://github.com/mouse07410/asn1c Related: OS#4945 Change-Id: If76f8619a9b2d46af6d94b8ae49348b8514e53aa
2022-07-13 15:27:15 +00:00
extern int asn1_xer_print;
/* SBcAP_ProcedureCode_t codes */
#define SBcAP_ProcedureId_Write_Replace_Warning 0
#define SBcAP_ProcedureId_Stop_Warning 1
#define SBcAP_ProcedureId_Error_Indication 2
#define SBcAP_ProcedureId_Write_Replace_Warning_Indication 3
#define SBcAP_ProcedureId_Stop_Warning_Indication 4
#define SBcAP_ProcedureId_PWS_Restart_Indication 5
#define SBcAP_ProcedureId_PWS_Failure_Indication 6
SBcAP_SBC_AP_PDU_t *sbcap_pdu_alloc(void);
void sbcap_pdu_free(SBcAP_SBC_AP_PDU_t *pdu);
struct msgb *sbcap_encode(SBcAP_SBC_AP_PDU_t *pdu);
SBcAP_SBC_AP_PDU_t *sbcap_decode(const struct msgb *msg);
sbcap: Log info about messages received and trasmitted Change-Id: Ifd1eca79bf4fac63de8066cd6a18004138d51d04
2022-07-27 15:46:14 +00:00
const char *sbcap_procedure_code_str(SBcAP_ProcedureCode_t pc);
Add sbcap library This commit adds initial support to encode/decode SBc-AP messages in the form of a library, under src/sbcap/ (includes in include/osmocom/sbcap/). asn1c is used to generate all suport code and structures for ASN.1 APER encoding/decoding, based on asn files obtained from 3GPP TS 29.168 and stored under src/sbcap/asn1/. Currently, mainstream asn1c doesn't yet support ASN.1 APER encoding/decoding, hence mouse07410 's fork is used [1]. Furthermore, several encdoing/decoding bugs where found during the process and fixed, which means asn1.c git >= 30219de2d3da888b4f1eea0dd79f2a505000401a must be used to generate proper code. A new "make -C src/ gen" target is added which can be used to regenerate all C code from the available ASN.1 files in src/sbcap/asn1/*.asn (after properly setting configure.ac ASN_* variables if needed). [1] https://github.com/mouse07410/asn1c Related: OS#4945 Change-Id: If76f8619a9b2d46af6d94b8ae49348b8514e53aa
2022-07-13 15:27:15 +00:00
const char *sbcap_cause_str(SBcAP_Cause_t cause);
Move ASN1C enc/dec logging to its own category ASN1C encoding/decoding can get really verbose. Furthermore, it should only be enabled under really specific conditions, so it makes sense to have it under its own category. Change-Id: Ia4cbae2395532d9b5b7b9177a7d0f31bf777d751
2022-07-27 15:58:10 +00:00
void sbcap_set_log_area(int log_area_sbcap, int log_area_asn1c);
Add sbcap library This commit adds initial support to encode/decode SBc-AP messages in the form of a library, under src/sbcap/ (includes in include/osmocom/sbcap/). asn1c is used to generate all suport code and structures for ASN.1 APER encoding/decoding, based on asn files obtained from 3GPP TS 29.168 and stored under src/sbcap/asn1/. Currently, mainstream asn1c doesn't yet support ASN.1 APER encoding/decoding, hence mouse07410 's fork is used [1]. Furthermore, several encdoing/decoding bugs where found during the process and fixed, which means asn1.c git >= 30219de2d3da888b4f1eea0dd79f2a505000401a must be used to generate proper code. A new "make -C src/ gen" target is added which can be used to regenerate all C code from the available ASN.1 files in src/sbcap/asn1/*.asn (after properly setting configure.ac ASN_* variables if needed). [1] https://github.com/mouse07410/asn1c Related: OS#4945 Change-Id: If76f8619a9b2d46af6d94b8ae49348b8514e53aa
2022-07-13 15:27:15 +00:00
sbcap: Send Error Indication if decoding rx msg fails Change-Id: I444290f3d697e7485e04eaa38acd8fc3623e0eab
2022-07-26 09:55:42 +00:00
SBcAP_ProcedureCode_t sbcap_pdu_get_procedure_code(const SBcAP_SBC_AP_PDU_t *pdu);
SBcAP_Criticality_t sbcap_pdu_get_criticality(const SBcAP_SBC_AP_PDU_t *pdu);
sbcap: Log info about messages received and trasmitted Change-Id: Ifd1eca79bf4fac63de8066cd6a18004138d51d04
2022-07-27 15:46:14 +00:00
const char *sbcap_pdu_get_name(const SBcAP_SBC_AP_PDU_t *pdu);
sbcap: Send Error Indication if decoding rx msg fails Change-Id: I444290f3d697e7485e04eaa38acd8fc3623e0eab
2022-07-26 09:55:42 +00:00
Move sbcap_as_find_ie() to libsbcap This function is generic and can be (will be) used in more places. Change-Id: Ib0c7fa12a8f6faa4271e4132ca5a5c656e717400
2022-07-26 13:33:29 +00:00
void *sbcap_as_find_ie(void *void_list, SBcAP_ProtocolIE_ID_t ie_id);
Add sbcap library This commit adds initial support to encode/decode SBc-AP messages in the form of a library, under src/sbcap/ (includes in include/osmocom/sbcap/). asn1c is used to generate all suport code and structures for ASN.1 APER encoding/decoding, based on asn files obtained from 3GPP TS 29.168 and stored under src/sbcap/asn1/. Currently, mainstream asn1c doesn't yet support ASN.1 APER encoding/decoding, hence mouse07410 's fork is used [1]. Furthermore, several encdoing/decoding bugs where found during the process and fixed, which means asn1.c git >= 30219de2d3da888b4f1eea0dd79f2a505000401a must be used to generate proper code. A new "make -C src/ gen" target is added which can be used to regenerate all C code from the available ASN.1 files in src/sbcap/asn1/*.asn (after properly setting configure.ac ASN_* variables if needed). [1] https://github.com/mouse07410/asn1c Related: OS#4945 Change-Id: If76f8619a9b2d46af6d94b8ae49348b8514e53aa
2022-07-13 15:27:15 +00:00
SBcAP_Write_Replace_Warning_Request_IEs_t *sbcap_alloc_Write_Replace_Warning_Request_IE(
long id, SBcAP_Criticality_t criticality, SBcAP_Write_Replace_Warning_Request_IEs__value_PR present);
SBcAP_Stop_Warning_Request_IEs_t *sbcap_alloc_Stop_Warning_Request_IE(
long id, SBcAP_Criticality_t criticality, SBcAP_Stop_Warning_Request_IEs__value_PR present);
sbcap: Send Error Indication if decoding rx msg fails Change-Id: I444290f3d697e7485e04eaa38acd8fc3623e0eab
2022-07-26 09:55:42 +00:00
SBcAP_ErrorIndicationIEs_t *sbcap_alloc_Error_Indication_IE(
long id, SBcAP_Criticality_t criticality, SBcAP_Stop_Warning_Request_IEs__value_PR present);