libosmocore  1.5.1
Osmocom core library
prim.h
Go to the documentation of this file.
1 #pragma once
2 
19 #include <stdint.h>
20 #include <osmocom/core/msgb.h>
21 
22 #define OSMO_PRIM(prim, op) ((prim << 8) | (op & 0xFF))
23 #define OSMO_PRIM_HDR(oph) OSMO_PRIM((oph)->primitive, (oph)->operation)
24 
31 };
32 
33 extern const struct value_string osmo_prim_op_names[5];
34 
36 #define _SAP_GSM_SHIFT 24
37 
38 #define _SAP_GSM_BASE (0x01 << _SAP_GSM_SHIFT)
39 #define _SAP_TETRA_BASE (0x02 << _SAP_GSM_SHIFT)
40 #define _SAP_SS7_BASE (0x03 << _SAP_GSM_SHIFT)
41 
43 struct osmo_prim_hdr {
44  unsigned int sap;
45  unsigned int primitive;
47  struct msgb *msg;
54 };
55 
63 static inline void
64 osmo_prim_init(struct osmo_prim_hdr *oph, unsigned int sap,
65  unsigned int primitive, enum osmo_prim_operation operation,
66  struct msgb *msg)
67 {
68  oph->sap = sap;
69  oph->primitive = primitive;
70  oph->operation = operation;
71  oph->msg = msg;
72 }
73 
75 typedef int (*osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx);
76 
79 #define OSMO_NO_EVENT 0xFFFFFFFF
80 
83  unsigned int sap;
84  unsigned int primitive;
86  uint32_t event;
87 };
88 
89 uint32_t osmo_event_for_prim(const struct osmo_prim_hdr *oph,
90  const struct osmo_prim_event_map *maps);
osmo_prim_cb
int(* osmo_prim_cb)(struct osmo_prim_hdr *oph, void *ctx)
primitive handler callback type
Definition: prim.h:75
osmo_prim_event_map
single entry in a SAP/PRIM/OP -> EVENT map
Definition: prim.h:82
osmo_prim_operation
osmo_prim_operation
primitive operation
Definition: prim.h:26
osmo_prim_event_map::sap
unsigned int sap
SAP to match.
Definition: prim.h:83
osmo_prim_hdr
Osmocom primitive header.
Definition: prim.h:43
osmo_prim_init
static void osmo_prim_init(struct osmo_prim_hdr *oph, unsigned int sap, unsigned int primitive, enum osmo_prim_operation operation, struct msgb *msg)
Convenience function to initialize a primitive header.
Definition: prim.h:64
PRIM_OP_INDICATION
@ PRIM_OP_INDICATION
indication
Definition: prim.h:29
msg
uint8_t msg[0]
PRIM_OP_REQUEST
@ PRIM_OP_REQUEST
request
Definition: prim.h:27
osmo_prim_hdr::operation
enum osmo_prim_operation operation
Definition: prim.h:46
msgb
Osmocom message buffer.
Definition: msgb.h:35
osmo_prim_event_map::event
uint32_t event
event as result if above match
Definition: prim.h:86
osmo_prim_hdr::msg
struct msgb * msg
Primitive Operation.
Definition: prim.h:47
osmo_event_for_prim
uint32_t osmo_event_for_prim(const struct osmo_prim_hdr *oph, const struct osmo_prim_event_map *maps)
resolve the (fsm) event for a given primitive using a map
Definition: prim.c:28
osmo_prim_op_names
const struct value_string osmo_prim_op_names[5]
The upper 8 byte of the technology, the lower 24 bits for the SAP.
Definition: prim.c:16
osmo_prim_event_map::operation
enum osmo_prim_operation operation
operation to match
Definition: prim.h:85
msgb.h
value_string
A mapping between human-readable string and numeric value.
Definition: utils.h:42
osmo_prim_hdr::primitive
unsigned int primitive
Primitive number.
Definition: prim.h:45
osmo_prim_event_map::primitive
unsigned int primitive
primtiive to match
Definition: prim.h:84
PRIM_OP_CONFIRM
@ PRIM_OP_CONFIRM
confirm
Definition: prim.h:30
osmo_prim_hdr::sap
unsigned int sap
Service Access Point Identifier.
Definition: prim.h:44
PRIM_OP_RESPONSE
@ PRIM_OP_RESPONSE
response
Definition: prim.h:28