Newer
Older
* @author ETSI / STF405 / STF449
* @version $URL$
* $Id$
* @desc Module containing types and values for GeoNetworking Protocol
*
*/
module LibItsGeoNetworking_TypesAndValues {
//LibCommon
import from LibCommon_BasicTypesAndValues all;
import from LibCommon_DataStrings all;
import from LibItsCommon_TypesAndValues all;
import from LibItsBtp_TypesAndValues {type BtpPacket;}
import from LibItsIpv6OverGeoNetworking_TypesAndValues {type Ipv6Packet;}
group geoConfigurationValues {
const charstring c_compIut := "IUT";
const charstring c_compNodeA := "NodeA";
const charstring c_compNodeB := "NodeB";
const charstring c_compNodeC := "NodeC";
const charstring c_compNodeD := "NodeD";
const charstring c_area1 := "AREA1";
const charstring c_area2 := "AREA2";
const integer c_latitudeFactorNodeA := 3;
const integer c_latitudeFactorNodeB := 2;
const integer c_latitudeFactorNodeC := -1;
const integer c_latitudeFactorNodeD := 1;
const integer c_longitudeFactorNodeA := 0;
const integer c_longitudeFactorNodeB := 0;
const integer c_longitudeFactorNodeC := 0;
const integer c_longitudeFactorNodeD := 0;
tepelmann
committed
group geoSyncMessages {
const charstring c_msgSent := "Message sent";
} // end geoSyncMessages
const UInt6 c_defaultLifetime := 10; // in seconds
group units {
const float c_squareKm := 1000000.0;
} // end units
/**
* @desc Entry of position table
* @member key Reference key of the entry
* @member position Position vector stored in the entry
*/
type record PositionEntry {
charstring key,
/**
* @desc Table containing node positions
*/
type record of PositionEntry PositionTable;
/**
* @desc Parameters of a geometric area
* @member geoAreaPosLatitude Latitude of area's center
* @member geoAreaPosLongitude Longitude of area's center
* @member distanceA Distance A
* @member distanceB Distance B
* @member angle Angle
*/
Int32 geoAreaPosLatitude,
Int32 geoAreaPosLongitude,
/**
* @desc Compact definition of GeoBroadcastArea
* @member geoBroadcastSubType Type of GeoBroadcastArea (=shape)
type record GeoBroadcastArea {
HeaderSubTypeGeoBroadcast geoBroadcastSubType,
Area geoBroadcastArea
}
/**
* @desc Compact definition of GeoAnycastArea
* @member geoAnycastSubType Type of GeoAnycastArea (=shape)
* @member geoAnycastArea Parameters of the geometric area
*/
type record GeoAnycastArea {
/**
* @desc Compact definition of a GeoArea (either GeoBroadcastArea or GeoAnycastArea)
* @member shape Shape of the GeoArea
* @member area Parameters of the geometric area
*/
type record GeoArea {
GeoShape shape,
Area area
}
/**
* @desc Geometric shapes used to define GeoAreas
*/
type enumerated GeoShape {
e_geoCircle(0),
e_geoRect(1),
e_geoElip(2),
e_reserved
}
/**
* @desc Entry of GeoArea table
* @member key Reference key of the entry
* @member geoArea GeoArea stored in the entry
*/
type record GeoAreaEntry {
charstring key,
GeoArea geoArea
}
/**
* @desc Table containing geoArea definitions
*/
type record of GeoAreaEntry GeoAreaTable;
group geoNwValues {
group geoNwHeaderConstants {
const UInt4 c_geoNwProtocolVersion := 0;
const UInt8 c_hopLimit1 := 1;
const UInt8 c_defaultHopLimit := 10;
} // end geoNwHeaderConstants
/**
* @desc GeoNetworking Packet
type record GeoNetworkingPdu {
BasicHeader basicHeader,
GeoNetworkingPacket gnPacket
type union GeoNetworkingPacket {
GnNonSecuredPacket packet,
GnSecuredPacket securedPacket
}
type record GnNonSecuredPacket {
CommonHeader commonHeader,
ExtendedHeader extendedHeader optional,
Payload payload optional
}
type union GnSecuredPacket {
GnNonSecuredPacket plainPacket,
octetstring securedPacket
}
} // end group geoNetworkingPdus
group geoNetworkingHeader {
group geoNetworkingBasicHeader {
/**
* @desc Basic Header
* <pre>
* 0 1 2 3
* 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | V | NH | Reserved | LT | RHL |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* </pre>
*
* @see ETSI EN 302 636-4-1 chapter 8.6.1
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
* @member version
* @member nextHeader
* @member reserved
* @member lifeTime
* @member routerHopLimit
*/
type record BasicHeader {
UInt4 version,
BasicNextHeader nextHeader,
UInt8 reserved,
Lifetime lifeTime,
UInt8 routerHopLimit
}
type enumerated BasicNextHeader {
e_any(0),
e_commonHeader(1),
e_securedPacket(2),
e_reserved
} with {
variant "4 bit"
}
/**
* @desc Indicates the maximum tolerable time a packet can be buffered until it reaches its destination.
* @member multiplier
* @member ltBase
*/
type record Lifetime {
UInt6 multiplier,
LtBase ltBase
}
/**
* @desc The base for the calculation of the lifetime.
*/
type enumerated LtBase {
e_50ms(0),
e_1s(1),
e_10s(2),
e_100s(3)
} with {
variant "2 bit"
}
} // end group geoNetworkingBasicHeader
group geoNetworkingCommonHeader {
/**
* @desc Common header for GeoNetworking
* <pre>
* 0 1 2 3
* 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | NH | R | HT | HST | TC | Flags |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | PL | MHL | Reserved |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* </pre>
*
* @see ETSI EN 302 636-4-1 chapter 8.7.2
* @member nextHeader
* @member reserved
* @member headerTST Header type + Header Sub Type
* @member trafficClass
* @member flags
* @member plLength
* @member maxHopLimit
* @member reserved2
*/
type record CommonHeader {
NextHeader nextHeader,
HeaderTST headerTST,
TrafficClass trafficClass,
Bit8 flags,
UInt16 plLength, // The Codec shall set the length of the paylaod if present
UInt8 maxHopLimit,
UInt8 reserved2
/**
* @desc Identifies the type of header immediately following the Common Header (4Bits).
*/
type enumerated NextHeader {
e_any(0),
e_btpA(1),
e_btpB(2),
e_ipv6(3),
e_reserved
} with {
variant "4 bits"
}
type UInt8 TrafficClass;
} // end group geoNetworkingCommonHeader
group geoNetworkingExtendedHeaders {
/**
* @desc GeoNetworking ExtendedHeader
* @member commonHeader
* @member gnExtHeader
*/
type union ExtendedHeader {
GeoUnicastHeader geoUnicastHeader,
TSBHeader tsbHeader,
SHBHeader shbHeader,
GeoBroadcastHeader geoBroadcastHeader,
GeoAnycastHeader geoAnycastHeader,
BeaconHeader beaconHeader,
LSRequestHeader lsRequestHeader,
LSReplyHeader lsReplyHeader,
AnyHeader anyHeader
}
/**
* @desc The unspecified ANY header.
* @member seqNumber
* @member reserved
*/
type record AnyHeader {
UInt16 seqNumber,
}
/**
* @desc The BEACON packet header.
*
*
* @member commonHeader
*/
type record BeaconHeader {
*
* @member seqNumber
* @member reserved
* @member srcPosVector
* @member geoAreaPosLatitude
* @member geoAreaPosLongitude
* @member distanceA
* @member distanceB
* @member angle
* @member reserved
Int32 geoAreaPosLatitude,
Int32 geoAreaPosLongitude,
UInt16 reserved2
*
* @member seqNumber
* @member reserved
* @member srcPosVector
* @member geoAreaPosLatitude
* @member geoAreaPosLongitude
* @member distanceA
* @member distanceB
* @member angle
* @member reserved
*
* @member seqNumber
* @member reserved
* @member srcPosVector
* @desc The Location Service (LS) Reply packet header.
*
* @member seqNumber
* @member reserved
* @member srcPosVector
type record LSReplyHeader {
UInt16 seqNumber,
LongPosVector srcPosVector,
/**
* @desc The Location Service (LS) Request packet header.
*
*
* @member seqNumber
* @member reserved
* @member srcPosVector
* @member gnAddress
*/
type record LSRequestHeader {
UInt16 seqNumber,
LongPosVector srcPosVector,
GN_Address gnAddress
}
/**
* The Single Hop Broadcast (SHB) packet header.
}
/**
* @desc The Topologically-Scoped Broadcast (TSB) packet header.
*
*
* @member seqNumber
* @member reserved
* @member srcPosVector
*/
LongPosVector srcPosVector
}
group geoNetworkingHeadersSubtypes {
/**
* @desc Identifies the header type and the header subtype for ANY.
* @member headerType
* @member reserved
type record AnyHeaderType {
HeaderType headerType(e_any),
* @desc Identifies the header type and the header subtype for BEACON.
* @member headerType
* @member reserved
type record BeaconHeaderType {
HeaderType headerType(e_beacon),
* @desc Identifies the header type and the header subtype for GEOANYCAST.
* @member headerType
* @member reserved
type record GeoAnycastHeaderType {
HeaderType headerType(e_geoAnycast),
HeaderSubTypeGeoAnycast headerSubType
* @desc Identifies the header type and the header subtype for GEOBROADCAST.
* @member headerType
type record GeoBroadcastHeaderType {
HeaderType headerType(e_geoBroadcast),
HeaderSubTypeGeoBroadcast headerSubType
* @desc Identifies the header type and the header subtype for GEOUNICAST.
* @member headerType
* @member reserved
*/
type record GeoUnicastHeaderType {
HeaderType headerType(e_geoUnicast),
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
/**
* @desc Identifies the header type and the header subtype for Location Service LS.
* @member headerType
* @member reserved
*/
type record LsHeaderType {
HeaderType headerType(e_locationService),
HeaderSubTypeLs headerSubType
}
/**
* @desc Identifies the header type and the header subtype for Service Announcement SA.
* @member headerType
* @member reserved
*/
type record SaHeaderType {
HeaderType headerType(e_serviceAnnouncement),
HeaderSubTypeSa headerSubType
}
/**
* @desc Identifies the header type and the header subtype for Topologically-Scoped Broadcast TSB.
* @member headerType
* @member headerSubType
*/
type record TsbHeaderType {
HeaderType headerType(e_topologicallyScopedBroadcast),
HeaderSubTypeTSB headerSubType
}
* @desc Identifies the header subtype for GEOANYCAST.
type enumerated HeaderSubTypeGeoAnycast {
e_geoAnycastCircle(0),
e_geoAnycastRect(1),
e_geoAnycastElip(2),
e_reserved
* @desc Identifies the header subtype for GEOBROADCAST.
type enumerated HeaderSubTypeGeoBroadcast {
e_geoBroadcastCircle(0),
e_geoBroadcastRect(1),
e_geoBroadcastElip(2),
e_reserved
/**
* @desc Identifies the header subtype for Topologically-scoped broadcast TSB.
*/
type enumerated HeaderSubTypeTSB {
e_singleHop(0),
e_multiHop(1),
e_reserved
* @desc Identifies the header subtype for Location Service LS.
type enumerated HeaderSubTypeLs {
e_lsRequest(0),
e_lsReply(1),
e_reserved
* @desc Identifies the header subtype for Service Announcement SA.
type enumerated HeaderSubTypeSa {
e_sa(0),
e_saEos(1),
e_reserved
* @desc Identifies the header type and the header subtype.
* @member anyHdr
* @member beaconHdr
* @member geoUnicastHdr
* @member geoAnycastHdr
* @member geoBroadcastHdr
* @member tsbHdr
* @member lsHdr
* @member saHdr
type union HeaderTST {
AnyHeaderType anyHdr,
BeaconHeaderType beaconHdr,
GeoUnicastHeaderType geoUnicastHdr,
GeoAnycastHeaderType geoAnycastHdr,
GeoBroadcastHeaderType geoBroadcastHdr,
TsbHeaderType tsbHdr,
LsHeaderType lsHdr,
SaHeaderType saHdr,
UInt8 reserved
* @desc Identifies the type of the GeoAdhoc header type (4Bits).
type enumerated HeaderType {
e_any(0),
e_beacon(1),
e_geoUnicast(2),
e_geoAnycast(3),
e_geoBroadcast(4),
e_topologicallyScopedBroadcast(5),
e_locationService(6),
e_serviceAnnouncement(7),
e_reserved
* <pre>
* 0 1 2 3
* 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | GN_ADDR |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | TST |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Lat |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Long |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* </pre>
*
type record LongPosVector {
GN_Address gnAddr,
UInt32 timestamp,
Int32 latitude,
Int32 longitude,
* <pre>
* 0 1 2 3
* 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | GN_ADDR |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | TST |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Lat |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | Long |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* </pre>
*
type record ShortPosVector {
GN_Address gnAddr,
UInt32 timestamp,
Int32 latitude,
Int32 longitude
}
group geoNetworkingAddress {
/**
* @desc GeoNetworking address
* <pre>
* 0 1 2 3
* 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* | M_ID |
* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
* </pre>
*
* @member typeOfAddress
* @member stationType
* @member mid
*/
type record GN_Address {
TypeOfAddress typeOfAddress,
StationType stationType,
}
group geoNetworkingAddressSubtypes {
/**
type enumerated StationType {
e_unknown(0),
e_pedestrian(1),
e_cyclist(2),
e_moped(3),
e_motorcycle(4),
e_passengerCar(5),
e_bus(6),
e_lightTruck(7),
e_heavyTruck(8),
e_trailer(9),
e_specialVehicle(10),
e_tram(11),
e_roadSideUnit(15)
* network address and the initial GeoNetwork address (1Bit).
type enumerated TypeOfAddress {
e_manual(1),
e_initial(0)
}
} // end group geoNetworkingAddressSubtypes
} // end group geoNetworkingAddress
} // end group geoNetworkingHeadersSubtypes
} // end group geoNetworkingHeader
group geoNetworkingPayload {
* @member decodedPayload The decoded payload
* @member rawPayload Raw payload as it is received
type record Payload {
DecodedPayload decodedPayload optional,
octetstring rawPayload
}
/**
* @desc The decoded payload of the GN packet
* @member ipv6Packet The IPv6 packet
* @member btpPacket BTP packet
Ipv6Packet ipv6Packet,
} with {
encode (ipv6Packet) "LibItsIpv6OverGeoNetworking";
encode (btpPacket) "LibItsBtp"
} //end group geoNetworkingPayload
/**
* @desc The GeoUnicast forwarding algorithm.
*/
type enumerated GeoUnicastForwardingAlgorithm {
e_unspecified(0),
e_greedy(1),
e_cbf(2)
}
/**
* @desc The GeoBroadcast forwarding algorithm.
*/
type enumerated GeoBroadcastForwardingAlgorithm {
e_unspecified(0),
e_simple(1),
e_advanced(2)
}
} // end geoNwPicsTypes
/**
* @desc Upper Tester message to check event/status on IUT
*/
type record UtCheck { /* FIXME: change this as in DENM */
UtGnTrigger utEvent
}
/**
* @desc Upper Tester response message
/**
* @desc UT primitives for GeoNetworking
* @member geoUnicast -
* @member geoBroadcast -
* @member geoAnycast -
* @member shb -
* @member tsb -
* @member changePosition -
* @member checkPacket -
*/
GenerateGeoUnicastMessage geoUnicast,
GenerateGeoBroadcastMessage geoBroadcast,
GenerateGeoAnycastMessage geoAnycast,
GenerateSHBMessage shb,
GeoNetworkingPdu checkPdu /* FIXME: obselete, to be removed */
/**
* @desc UT primitive for IUT to send a GeoUnicast packet
* @member gnAddress Destination of the packet
* @member lifetime Lifetime of the packet
* @member payload Payload of the packet
*/
type record GenerateGeoUnicastMessage {
GN_Address gnAddress,
Payload payload optional
}
/**
* @desc UT primitive for IUT to send a GeoBroadcast packet
* @member area Destination GeoArea
* @member payload Payload of the packet
*/
type record GenerateGeoBroadcastMessage {
Payload payload optional
}
/**
* @desc UT primitive for IUT to send a Geoanycast packet
*/
type GenerateGeoBroadcastMessage GenerateGeoAnycastMessage;
/**
* @desc UT primitive for IUT to send a SHB packet
* @member payload Payload of the packet
*/
type record GenerateSHBMessage {
Payload payload optional
}
/**
* @desc UT primitive for IUT to send a TSB packet
*/
type GenerateSHBMessage GenerateTSBMessage;
} // end utPrimitives
with {
encode "UpperTester"
}
/**
* @desc TA primitives for GeoNetworking
* @member startBeaconing -
* @member stopBeaconing -
* @member startPassBeaconing -
* @member stopPassBeaconing -
* @member startBeaconingMultipleNeighbour -
* @member stopBeaconingMultipleNeighbour -
* @member getLongPosVector -
*/
AcStartBeaconing startBeaconing,
AcStopBeaconing stopBeaconing,
AcStartPassBeaconing startPassBeaconing,
AcStopPassBeaconing stopPassBeaconing,
AcStartBeaconingMultipleNeighbour startBeaconingMultipleNeighbour,
AcStopBeaconingMultipleNeighbour stopBeaconingMultipleNeighbour,
/**
* @desc Primitive for receiveing response from TA
* @member getLongPosVector
*/
type record AcGnResponseFailure {
boolean failure
}
* @desc Primitive for TA to start sending beacons for the test component
* @member beaconHeader Beacon template
*/
type record AcStartBeaconing {
BeaconHeader beaconHeader
}
/**
* @desc Primitive for TA to stop sending beacons for the test component
*/
type record AcStopBeaconing {
/**
* @desc Primitive for TA to start enqueueing received beacons
* @member beaconHeader Filter
*/
type record AcStartPassBeaconing {
BeaconHeader beaconHeader
}
/**
* @desc Primitive for TA to stop enqueueing received beacons
*/
type record AcStopPassBeaconing {
}
* @desc Primitive for TA to start sending beacons for multiple neighbours
* @member beaconHeader Beacon template
* @member numberOfNeighbour Number of neighbours to simulate
*/
type record AcStartBeaconingMultipleNeighbour {
BeaconHeader beaconHeader,
integer numberOfNeighbour
}
/**
* @desc Primitive for TA to stop sending beacons for multiple neighbours
*/
type record AcStopBeaconingMultipleNeighbour {
}
/**
* @desc Primitive for retrieving the position vector corresponding to a specific GN address
* @member gnAddress GN address to be searched
*/
GN_Address gnAddress
with {
encode "AdapterControl"
}