Telematics SDK - API Reference
v1.51.0
|
Typedefs | |
using | telux::cv2x::RxMetaDataValidity = uint32_t |
using | telux::cv2x::setVerificationLoadCallback = std::function< void(telux::common::ErrorCode error)> |
Variables | |
constexpr uint8_t | telux::cv2x::MAX_ANTENNAS_SUPPORTED = 2u |
This section contains C++ APIs related to Cellular-V2X operation. Applications need to have "radio" Linux group permissions to be able to operate successfully with underlying services.
class telux::cv2x::ICv2xConfigListener |
Listeners for ICv2xConfig must implement this interface.
Public Member Functions | |
virtual void | onConfigChanged (const ConfigEventInfo &info) |
virtual | ~ICv2xConfigListener () |
|
virtual |
Destructor for ICv2xConfigListener
|
virtual |
Called when CV2X configuration has changed in the below scenarios:
[in] | info | - Information of CV2X configuration event. |
class telux::cv2x::ICv2xConfig |
Cv2xConfig provide operations to update or request cv2x configuration.
Public Member Functions | |
virtual | ~ICv2xConfig () |
virtual bool | isReady ()=0 |
virtual std::future< bool > | onReady ()=0 |
virtual telux::common::ServiceStatus | getServiceStatus ()=0 |
virtual telux::common::Status | updateConfiguration (const std::string &configFilePath, telux::common::ResponseCallback cb)=0 |
virtual telux::common::Status | retrieveConfiguration (const std::string &configFilePath, telux::common::ResponseCallback cb)=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< ICv2xConfigListener > listener)=0 |
virtual telux::common::Status | deregisterListener (std::weak_ptr< ICv2xConfigListener > listener)=0 |
|
virtual |
|
pure virtual |
Checks if the Cv2x Config Manager is ready.
|
pure virtual |
Wait for Cv2x Config to be ready.
|
pure virtual |
This status indicates whether the Cv2xConfig is in a usable state.
|
pure virtual |
Updates CV2X configuration. Requires CV2X TX/RX radio status be Inactive. If CV2X radio status is Active or Suspended, call ICv2xRadioManager::stopCv2x before trying to update configuration. The functionality of V2X configuration expiration is supported by adding an expiration leaf to the V2X configuration file passed in. When the active configuration expires, the system fallbacks to a lower priority V2X configuration ConfigSourceType if existed. If the V2X stauts is active, it changes to suspended when the active V2X configuration expires and then changes to active after the system fallbacks to a lower priority V2X configuration or changes to inactive if no V2X configuration is available.
[in] | configFilePath | - Path to config file. This is the fully qualified file path including the name of the file. |
[in] | cb | - Callback that is invoked when the send is complete. This may be null. |
|
pure virtual |
Retrieve active CV2X configuration. The calling application should have write access to the path specified by configFilePath. And if the v2x configuration retrieval request succeed, the file specified by configFilePath will be created and filled with the configuration contents. Otherwise, no file will be created.
[in] | configFilePath | - Path to config file. This is the fully qualified file path including the name of the file. |
[in] | cb | - Callback that is invoked when the configuration retrival is complete. This may be null. |
|
pure virtual |
Registers a listener for this ICv2xConfig.
[in] | listener | - Listener that implements ICv2xConfigListener interface. |
|
pure virtual |
Deregisters a listener for this ICv2xConfig.
[in] | listener | - Previously registered ICv2xConfigListener that is to be deregistered. |
class telux::cv2x::Cv2xFactory |
Cv2xFactory is the factory that creates the Cv2x Radio.
Public Member Functions | |
virtual std::shared_ptr< ICv2xRadioManager > | getCv2xRadioManager (telux::common::InitResponseCb cb=nullptr)=0 |
virtual std::shared_ptr< ICv2xConfig > | getCv2xConfig (telux::common::InitResponseCb cb=nullptr)=0 |
virtual std::shared_ptr< ICv2xThrottleManager > | getCv2xThrottleManager (telux::common::InitResponseCb cb=nullptr)=0 |
Static Public Member Functions | |
static Cv2xFactory & | getInstance () |
|
static |
Get Cv2xFactory instance
|
pure virtual |
Get Cv2xRadioManager instance.
[in] | cb | - Optional callback to get Cv2xRadioManager initialization status |
|
pure virtual |
Get Cv2xConfig instance.
[in] | cb | - Optional callback to get Cv2xConfig initialization status |
|
pure virtual |
Get Cv2xThrottleManager instance.
class telux::cv2x::ICv2xRadio |
This is class encapsulates a Cv2xRadio interface.
Returned from ICv2xRadioManager::getCv2xRadio
|
virtual |
Destructor for ICv2xRadio
|
pure virtual |
Get the capabilities of this Cv2xRadio.
|
pure virtual |
Returns true if the radio interface was successfully initialized.
|
pure virtual |
Returns true if the radio interface has completed initialization.
|
pure virtual |
Returns a future that indicated if the radio interface is ready or if radio failed to initialize.
|
pure virtual |
Registers a listener for this Cv2xRadio.
[in] | listener | - Listener that implements Cv2xRadioListener interface. |
|
pure virtual |
Deregisters a listener from this Cv2xRadio.
[in] | listener | - Previously registered Cv2xRadioListener that is to be deregistered. |
|
pure virtual |
Creates and initializes a new Rx subscription which will be returned in the user-supplied callback.
[in] | ipType | - IP traffic type (IP or NON-IP) |
[in] | port | - Rx port number |
[in] | cb | - Callback function that is invoked when socket creation is complete. |
[in] | idList | - Service ID list to subscribe, optional parameter using nullptr by default. Subscribe wildcard if this parameter is set to nullptr. |
|
pure virtual |
Enable or disable (depends on the parameter "bool enable") the received packets' meta data report for the service IDs provided.
The meta data consist of RF RSSI (received signal strength indicator) status, 32-bit SCI Format 1 (3GPP TS 36.213, section 14.1), packet delay estimation, L2 destination ID, and the resource blocks used for the packet's transmission: subframe, subchannel index.
[in] | ipType | - IP traffic type (IP or NON-IP) |
[in] | enable | - enable the rx meta data if set to true, otherwise disable |
[in] | idList | - Service ID list of which the received packets' report are desired |
[in] | cb | - Callback that is invoked when meta data is enabled or disabled. |
|
pure virtual |
Creates a Tx SPS flow with the specified IP type, serviceId, and other parameters specified in reservation. Additionally, an option event flow will be created with the same IP type and serviceId. A Tx socket will be created and initialized for the SPS flow. A Tx socket will be created and initialized for the event flow if the optional event flow is specified.
[in] | ipType | - IP traffic type (IP or NON-IP) |
[in] | serviceId | - ID used for transmissions that will be mapped to an L2 destination address. Variable length 4-byte PSID or ITS_AID, or another service ID. |
[in] | spsInfo | - SPS reservation parameters. |
[in] | spsSrcPort | - Requested source port number for the bandwidth reserved SPS transmissions. |
[in] | eventSrcPortValid | - True if an optional event flow is desired. If this field is left false, the event flow will not be created. |
[in] | eventSrcPort | - Requested source port number for the optional event flow. |
[in] | cb | - Callback function that is invoked when socket creation is complete. This must not be null. |
|
pure virtual |
Creates an event flow. An associated Tx socket will be created and initialized.
[in] | ipType | - IP traffic type (IP or NON-IP) |
[in] | serviceId | - ID used for transmissions that will be mapped to an L2 destination address. Variable length 4-byte PSID or ITS_AID, or another service ID. |
[in] | eventSrcPort | - Local port number to which the socket is bound. Used for transmissions of this ID. |
[in] | cb | - Callback function that is invoked when socket creation is complete. This must not be null. |
|
pure virtual |
Creates an event flow. An associated Tx socket will be created and initialized.
[in] | ipType | - IP traffic type (IP or NON-IP) |
[in] | serviceId | - ID used for transmissions that will be mapped to an L2 destination address. Variable length 4-byte PSID or ITS_AID, or another service ID. |
[in] | flowInfo | - Flow configuration parameters |
[in] | eventSrcPort | - Local port number to which the socket is bound. Used for transmissions of this ID. |
[in] | cb | - Callback function that is invoked when socket creation is complete. This must not be null. |
|
pure virtual |
Closes the RxSubscription and frees resources (such as the Rx socket) associated with it.
[in] | rxSub | - RxSubscription to close |
[in] | cb | - Callback that is invoked when socket close is complete. This may be null. |
|
pure virtual |
Closes the TxFlow and frees resources associated with it (such as reserved SPS bandwidth contracts and sockets). This function works on both SPS and event flows.
[in] | txFlow | - Tx (SPS or event) flow to close. |
[in] | cb | - Callback that is invoked when Tx flow close is complete. This may be null. |
|
pure virtual |
Request to change TX SPS Flow reservation parameters.
[in] | txFlow | - Tx SPS flow |
[in] | spsInfo | - Desired SPS reservation parameters |
[in] | cb | - Callback that is invoked upon reservation change. This may be null. |
|
pure virtual |
Request SPS flow info.
[in] | txFlow | - Tx SPS flow |
[in] | cb | - Callback that will be invoked and returns the SPS info. Must not be null. |
|
pure virtual |
Request to change TX Event Flow reservation parameters.
[in] | txFlow | - Tx Event flow |
[in] | flowInfo | - Desired Event flow parameters |
[in] | cb | - Callback that is invoked upon parameter change. This may be null. |
|
pure virtual |
Request modem Cv2x capability information.
[in] | cb | - Callback that will be invoked and returns the capability info. Must not be null. |
|
pure virtual |
Request data session settings currently in use.
[in] | cb | - Callback that will be invoked and returns the data session settings. Must not be null. |
|
pure virtual |
Requests modem to change L2 info.
[in] | cb | - Callback that will be invoked and returns status. Must not be null. |
|
pure virtual |
Send request to modem to update the list of malicious UE source IDs and trusted UE source IDs with corresponding confidence information.
[in] | infoList | - Trusted and malicious UE information list |
[in] | cb | - Callback that will be invoked and returns status. Must not be null. |
|
pure virtual |
Get interface name based on ipType.
ipType | - IP traffic type (IP or NON-IP) |
|
pure virtual |
Creates a CV2X TCP socket with specified event flow information and TCP socket information. The TCP socket will be created and bound to the IPv6 address of local IP interface with specifed source port. Additionally, this API also registers a Tx event flow and subscribes Rx with specified service ID. If the created socket is expected to work as TCP client mode, the caller must connect the created socket to a destination using connect() and then use the socket for send() and recv() on successful connection. If the created socket is expected to work as TCP server mode, the caller must mark this socket as a listening socket using listen() and accept connections received from this listening socket using accept(), and then use the accepted sockets returned from accept() for send() or recv().
[in] | eventInfo | - Information for the Event flow. |
[in] | sockInfo | - Information for the TCP socket. |
[in] | cb | - Callback function that is invoked when socket creation is complete. This must not be null. |
|
pure virtual |
Closes the CV2X TCP socket and frees resources associated with it (such as registered event Tx flow and subscribed Rx service ID and created TCP socket).
[in] | sock | - CV2X TCP socket to close. |
[in] | cb | - Callback that is invoked when CV2X TCP socket close is complete. This may be null. |
|
pure virtual |
Registers a listener for Tx status report.
[in] | port | - Set this value to the port number of registered Tx Flow if user wants to receive Tx status report associated with its own Tx flow. If user wants to receive Tx status report associated with all Tx flows in system, set this value to 0. |
[in] | listener | - Listener that implements ICv2xTxStatusReportListener interface. |
[in] | cb | - Callback that is invoked when the registration of CV2X Tx status report is complete. |
|
pure virtual |
Deregisters a listener for Tx status report.
[in] | port | - Port number of previously registered ICv2xTxStatusReportListener that is to be deregistered. If the listener is registered with port number 0, set this value to 0 to deregister the listener. |
[in] | cb | - Callback that is invoked when the deregistration of CV2X Tx status report is complete. |
|
pure virtual |
Set CV2X global IP address for the IP interface.
Use case and Precondition: OBU: Registers a TX/RX NON IP flow for receiving the signed WSA/WRA for IP session initiation; Once receives the IP prefix in the WDS/WRA from RSU, call this method.
RSU: Specifies its own global prefix via this method, and creates/composes WSA/WRA advertising the IP configs.
[in] | ipv6Addr | - CV2X global IP address. |
[in] | cb | - Callback that is invoked when set the global IP address complete. This may be null. |
|
pure virtual |
Set CV2X IP interface global IP unicast routing information.
Use case and Precondition: OBU: Registers a TX/RX NON IP flow for receiving the signed WSA/WRA for IP session initiation; Once receives the IP prefix in the WSA/WRA from RSU, call the setGlobalIPInfo method to update the ip interface with global IP; Now call this method to set the routing information with dest L2 addr negotiated in WSA/WRA.
RSU: Specifies its own global prefix via setGlobalIPInfo, and creates/composes WSA/WRA advertising the IP configs; Now set routing information of its own via this method.
[in] | destL2Addr | - CV2X destination L2 address for unicast routing purpose. |
[in] | cb | - Callback that is invoked when set global IP unicast routing information complete. This may be null. |
class telux::cv2x::ICv2xRadioListener |
Listeners for Cv2xRadio must implement this interface.
Public Member Functions | |
virtual void | onStatusChanged (Cv2xStatus status) |
virtual void | onStatusChanged (Cv2xStatusEx status) |
virtual void | onL2AddrChanged (uint32_t newL2Address) |
virtual void | onSpsOffsetChanged (int spsId, MacDetails details) |
virtual void | onSpsSchedulingChanged (const SpsSchedulingInfo &schedulingInfo) |
virtual void | onCapabilitiesChanged (const Cv2xRadioCapabilities &capabilities) |
virtual | ~ICv2xRadioListener () |
|
virtual |
Destructor for ICv2xRadioListener
|
virtual |
Called when the status of the CV2X radio has changed.
[in] | status | - CV2X radio status. |
|
virtual |
Called when the status of the CV2X radio has changed.
[in] | status | - CV2X radio status. |
|
virtual |
Called when the L2 Address has changed.
[in] | newL2Address | - The new L2 address. |
|
virtual |
Called when SPS offset has changed.
[in] | spsId | - SPS Id of the SPS flow |
[in] | details | - new SPS MAC PHY details. |
|
virtual |
Called when SPS scheduling has changed.
[in] | schedulingInfo | - SPS scheduling information . |
|
virtual |
Called when Cv2x radio capabilities have changed.
[in] | capabilities | - Capabilities of the CV2X radio . |
class telux::cv2x::ICv2xRadioManager |
Cv2xRadioManager manages instances of Cv2xRadio.
|
virtual |
|
pure virtual |
Checks if the Cv2x Radio Manager is ready.
|
pure virtual |
Wait for Cv2x Radio Manager to be ready.
|
pure virtual |
This status indicates whether the Cv2xRadioManager is in a usable state.
|
pure virtual |
Get Cv2xRadio instance
[in] | category | - Specifies the category of the client application. This field is currently unused. |
|
pure virtual |
Put modem into CV2X mode.
[in] | cb | - Callback that is invoked when Cv2x mode is started |
|
pure virtual |
Take modem outo of CV2X mode
[in] | cb | - Callback that is invoked when Cv2x mode is stopped |
|
pure virtual |
request CV2X status from modem
[in] | cb | - Callback that is invoked when Cv2x status is retrieved |
|
pure virtual |
request CV2X status from modem
[in] | cb | - Callback that is invoked when Cv2x status is retrieved |
|
pure virtual |
Registers a listener for this manager.
[in] | listener | - Listener that implements Cv2xListener interface. |
|
pure virtual |
Deregisters a Cv2xListener for this manager.
[in] | listener | - Previously registered CvListener that is to be deregistered. |
|
pure virtual |
Updates CV2X configuration. Requires CV2X TX/RX radio status be Inactive. If CV2X radio status is Active or Suspended, call stopCv2x before updateConfiguration.
[in] | configFilePath | - Path to config file. |
[in] | cb | - Callback that is invoked when the send is complete. This may be null. |
|
pure virtual |
Set RF peak cv2x transmit power. This affects the power for all existing flows and for any flow created int the future
[in] | txPower | - Desired global Cv2x peak tx power in dbm |
[in] | cb | - Callback that is invoked when Cv2x peak tx power is set |
|
pure virtual |
Request to install remote UE src L2 filters. This affects receiving of the UEs' packets in specified period with specified PPPP
[in] | filterList | - remote UE src L2 Id, filter duration and PPPP list, max size 50 |
[in] | cb | - Callback that is invoked when the request is sent |
|
pure virtual |
Remove the previously installed filters matching src L2 address list. Hence forth this would allow reception of packets from specified UE's
[in] | l2IdList | - remote UE src L2 Id list, max size 50 |
[in] | cb | - Callback that is invoked when the request is sent |
struct telux::cv2x::SocketInfo |
Encapsulates parameters of a CV2X socket.
Used in ICv2xRadio::createCv2xTcpSocket.
Data Fields | ||
---|---|---|
uint32_t | serviceId |
V2X service ID bound to the socket. |
uint16_t | localPort |
Local port number of the socket used for binding. |
struct telux::cv2x::Cv2xStatus |
Encapsulates status of CV2X radio.
Used in ICv2xRadioManager::requestCv2xStatus and ICv2xRadioListener.
Data Fields | ||
---|---|---|
Cv2xStatusType | rxStatus |
RX status |
Cv2xStatusType | txStatus |
TX status |
Cv2xCauseType | rxCause |
RX cause of failure |
Cv2xCauseType | txCause |
TX cause of failure |
uint8_t | cbrValue |
Channel Busy Ratio |
bool | cbrValueValid |
CBR value is valid |
struct telux::cv2x::Cv2xPoolStatus |
Encapsulates status for single pool.
Used in Cv2xStatusEx.
Data Fields | ||
---|---|---|
uint8_t | poolId |
pool ID |
Cv2xStatus | status |
status |
struct telux::cv2x::Cv2xStatusEx |
Encapsulates status of CV2X radio and per pool status.
Used in ICv2xRadioManager::requestCv2xStatus and Cv2xRadioListener.
Data Fields | ||
---|---|---|
Cv2xStatus | status |
Overall Cv2x status |
vector< Cv2xPoolStatus > | poolStatus |
Multi pool status vector |
bool | timeUncertaintyValid |
Time uncertainty value is valid |
float | timeUncertainty |
Time uncertainty value in milleseconds |
struct telux::cv2x::TxPoolIdInfo |
Contains minimum and maximum EARFCNs for a given Tx pool ID. Multiple Tx Pools allow the same radio and overall frequency range to be shared for multiple types of traffic like V2V and V2X. Each pool ID and frequency range corresponds to a certain type of traffic. Both edge guard bands are not included in the EARFCN range reported. The calculation for the full bandwidth includes both edge guard bands is: bandwidth(MHz) = (maxFreq-minFreq)/9.
Used in Cv2xRadioCapabilities
Data Fields | ||
---|---|---|
uint8_t | poolId |
TX pool ID. |
uint16_t | minFreq |
Minimum EARFCN of this pool. |
uint16_t | maxFreq |
Maximum EARFCN of this pool. |
struct telux::cv2x::EventFlowInfo |
Contains event flow configuration parameters.
Used in ICv2xRadio::createTxEventFlow
struct telux::cv2x::SpsFlowInfo |
Used to request the QoS bandwidth contract, implemented in PC5 3GPP V2X radio as a Semi Persistent Flow (SPS).
The underlying radio providing the interface might support periodicities of various granularity in 100ms integer multiples (e.g. 200ms, 300ms).
Used in ICv2xRadio::createTxSpsFlow and ICv2xRadio::changeSpsFlowInfo
Data Fields | ||
---|---|---|
Priority | priority |
Specifies one of the 3GPP levels of Priority for the traffic that is pre-reserved on the SPS flow. Default is PRIORITY_2. Use getCapabilities() to discover the supported priority levels.
|
Periodicity | periodicity | |
uint64_t | periodicityMs |
This is the new interface to specify periodicity in milliseconds for SpsFlowInfo. Enum Periodicity is deprecated and will be removed in future release.Bandwidth-reserved periodicity interval in interval in milliseconds. There are limits on which intervals the underlying radio supports. Use getCapabilities() to discover minPeriodicityMultiplierMs and maximumPeriodicityMs. |
uint32_t | nbytesReserved |
Number of bytes of TX bandwidth that are sent every periodicity interval. |
bool | autoRetransEnabledValid |
Set to true if autoRetransEnabled field is specified. If false, the system will use the default setting. |
bool | autoRetransEnabled |
Used to enable automatic-retransmissions. |
bool | peakTxPowerValid |
Set to true if peakTxPower is used. If false, the system will use the default setting. |
int32_t | peakTxPower |
Max Tx power setting in dBm. |
bool | mcsIndexValid |
Set to true if mcsIndex is used. If false, the system will use its default setting. |
uint8_t | mcsIndex |
Modulation and Coding Scheme Index to use. |
bool | txPoolIdValid |
Set to true if txPoolId is used. If false, the system will use its default setting. |
uint8_t | txPoolId |
Transmission Pool ID. |
struct telux::cv2x::Cv2xRadioCapabilities |
Contains capabilities of the Cv2xRadio.
Used in ICv2xRadio::requestCapabilities and ICv2xRadioListener::onCapabilitiesChanged
Data Fields | ||
---|---|---|
uint32_t | linkIpMtuBytes |
Maximum data payload length (in bytes) of a packet supported by the IP Radio interface. |
uint32_t | linkNonIpMtuBytes |
Maximum data payload length (in bytes) of a packet supported by the non-IP Radio interface. |
RadioConcurrencyMode | maxSupportedConcurrency |
Indicates whether this interface supports concurrent WWAN with V2X (PC5). |
uint16_t | nonIpTxPayloadOffsetBytes |
Byte offset in a non-IP Tx packet before the actual payload begins. |
uint16_t | nonIpRxPayloadOffsetBytes |
Byte offset in a non-IP Rx packet before the actual payload begins.
|
bitset< 8 > | periodicitiesSupported | |
vector< uint64_t > | periodicities |
Specifies the periodicities supported |
uint8_t | maxNumAutoRetransmissions |
Least frequent bandwidth periodicity that is supported. Above this value, use event-driven periodic messages of a period larger than this value. |
uint8_t | layer2MacAddressSize |
Size of the L2 MAC address. Different Radio Access Technologies have different-sized L2 MAC addresses: 802.11 has 6 bytes, whereas 3GPP PC5 has only 3 bytes. Because a randomized MAC address comes from an HSM with good pseudo random entropy, higher layers must know how many bytes of the MAC address to generate. |
bitset< 8 > | prioritiesSupported |
Bit set of different priority levels supported by this Cv2xRadio. Refer to Priority |
uint16_t | maxNumSpsFlows |
Maximum number of supported SPS reservations. |
uint16_t | maxNumNonSpsFlows |
Maximum number of supported event flows (non-SPS ports). |
int32_t | maxTxPower |
Maximum supported transmission power. |
int32_t | minTxPower |
Minimum supported transmission power. |
vector< TxPoolIdInfo > | txPoolIdsSupported |
Vector of supported transmission pool IDs. |
uint8_t | isUnicastSupported |
Non zero value if UDP event unicast is supported. |
struct telux::cv2x::MacDetails |
Contains MAC information that is reported from the actual MAC SPS in the radio. The offsets can periodically change on any given transmission report.
struct telux::cv2x::SpsSchedulingInfo |
struct telux::cv2x::TrustedUEInfo |
Contains time confidence, position confidence, and propogation delay for a trusted UE.
Used in TrustedUEInfo
struct telux::cv2x::TrustedUEInfoList |
Contains list of malicious UE source L2 IDs. Contains list of trusted UE source L2 IDs and associated confidence values.
Used in ICv2xRadio::updateTrustedUEList
Data Fields | ||
---|---|---|
bool | maliciousIdsValid |
Malicious remote UE sources are valid. |
vector< uint32_t > | maliciousIds |
Malicious remote UE source L2 IDs. |
bool | trustedUEsValid |
Trusted remote UE sources are valid. |
vector< TrustedUEInfo > | trustedUEs |
Trusted remote UE sources. |
struct telux::cv2x::IPv6Address |
Contains IPv6 address.
Used in DataSessionSettings
Data Fields | ||
---|---|---|
uint8_t | addr[16] |
struct telux::cv2x::DataSessionSettings |
Contains packet data session settings.
Data Fields | ||
---|---|---|
bool | mtuValid |
Set to true if mtu is valid. |
uint32_t | mtu |
MTU size. |
bool | ipv6AddrValid |
Set to true if ipv6 address is valid. |
IPv6Address | ipv6Addr |
IPv6 address. |
struct telux::cv2x::ConfigEventInfo |
Information about any update to a CV2X config file.
Data Fields | ||
---|---|---|
ConfigSourceType | source |
The type of the V2X config file. |
ConfigEvent | event |
V2X config event. |
struct telux::cv2x::L2FilterInfo |
Contains remote UE source L2 ID that modem will drop on Rx.
Used in ICv2xRadioManager::setL2Filters
struct telux::cv2x::RFTxInfo |
Tx status per Tx chain and Tx power per Tx antenna for a specific transport block.
Used in TxStatusReport
Data Fields | ||
---|---|---|
RFTxStatus | status |
Fault detection status for a specific Tx chain. |
int32_t | power |
The target Tx power after MPR/AMPR reduction for a specific Tx antenna in dBm*10 format. Invalid value is -700, it means the corresponding antenna is not being used for the transmission of this transport block. |
struct telux::cv2x::TxStatusReport |
Information on Tx status of a V2X transport block that is reported from low layer.
Data Fields | ||
---|---|---|
RFTxInfo | rfInfo[MAX_ANTENNAS_SUPPORTED] |
Tx status per Tx chain and Tx power per Tx antenna. |
uint8_t | numRb |
Number of resource blocks used for the transport block. |
uint8_t | startRb |
Start resource block index used for the transport block. |
uint8_t | mcs |
Modulation and coding scheme used for the transport block that is defined in 3GPP TS 36.213. |
uint8_t | segNum |
Total number of segments of a V2X packet. |
SegmentType | segType |
Segment type of the transport block. |
TxType | txType |
Indication of new Tx or re-Tx of the transport block. |
uint16_t | otaTiming |
OTA timing in format of system frame number*10 + subframe number. |
uint16_t | port |
Port number that can be used to link the report to a specific Tx flow which has the same source port number. |
struct telux::cv2x::IPv6AddrType |
Encapsulates ipv6 prefix length in bits and ipv6 prefix.
Used in ICv2xRadio::setGlobalIPInfo.
Data Fields | ||
---|---|---|
uint8_t | prefixLen |
< ipv6 address prefix length in bits, range [64, 128] |
uint8_t | ipv6Addr[CV2X_IPV6_ADDR_ARRAY_LEN] |
struct telux::cv2x::GlobalIPUnicastRoutingInfo |
struct telux::cv2x::RxPacketMetaDataReport |
Contains the detailed meta data report of a packet received.
The meta data report comes from the same data interface as the packet itself, it consist of RF RSSI (received signal strength indicator) status, 32-bit SCI Format 1 (3GPP TS 36.213, section 14.1), packet delay estimation, L2 destination ID, and the resource blocks used for the packet's transmission: subframe, subchannel index.
The meta data is always received after the successful receipt of the corresponding packet. In order to associate the meta data report with the specific packet, the sfn and subChannelIndex should be present in the packet's payload and the meta data report, so the meta data report can be matched up to the packet.
There is no guarantee that all items listed above will be presented, metaDataMask need to be used for the validity. Use telux::cv2x::Cv2xRxMetaDataHelper::getRxMetaDataInfo to extract the meta data.
Data Fields | ||
---|---|---|
RxMetaDataValidity | metaDataMask | |
uint16_t | sfn | |
uint8_t | subChannelIndex | |
uint8_t | subChannelNum | |
int8_t | prxRssi | |
int8_t | drxRssi | |
uint32_t | l2DestinationId | |
uint32_t | sciFormat1Info | |
int32_t | delayEstimation |
class telux::cv2x::Cv2xRxMetaDataHelper |
Static Public Member Functions | |
static telux::common::Status | getRxMetaDataInfo (const uint8_t *payload, uint32_t payloadLength, size_t &metaDataLen, std::shared_ptr< std::vector< RxPacketMetaDataReport >> metaDatas) |
|
static |
class telux::cv2x::ICv2xRxSubscription |
This class encapsulates a Cv2xRadio Rx Subscription. It contains the Rx socket associated with the subscription from which client applications can read data. This class is referenced in ICv2xRadio::createRxSubscription and ICv2xRadio::closeRxSubscription.
Public Member Functions | |
virtual uint32_t | getSubscriptionId () const =0 |
virtual TrafficIpType | getIpType () const =0 |
virtual int | getSock () const =0 |
virtual struct sockaddr_in6 | getSockAddr () const =0 |
virtual uint16_t | getPortNum () const =0 |
virtual std::shared_ptr< std::vector< uint32_t > > | getServiceIDList () const =0 |
virtual void | setServiceIDList (const std::shared_ptr< std::vector< uint32_t >> idList)=0 |
virtual | ~ICv2xRxSubscription () |
|
virtual |
|
pure virtual |
Accessor for Rx subscription ID
|
pure virtual |
Accessor for IP traffic type
|
pure virtual |
Accessor for the socket file descriptor
|
pure virtual |
Accessor for the socket address description
|
pure virtual |
Accessor for the subscriptions's port number
|
pure virtual |
Get subscriptions's service ID list
|
pure virtual |
Set subscriptions's service ID list
[in] | idList | - the subscriptions's service ID list |
class telux::cv2x::ICv2xThrottleManagerListener |
Listener class for getting filter rate update notification.
Public Member Functions | |
virtual void | onFilterRateAdjustment (int rate) |
virtual void | onServiceStatusChange (telux::common::ServiceStatus status) |
virtual | ~ICv2xThrottleManagerListener () |
|
virtual |
Destructor of ICv2xThrottleManagerListener
|
virtual |
This API is invoked to advise the client to adjust the incoming message filtering rate by rate
messages/second. If the rate
is positive, it indicates the client to filter rate
more messages/second If the rate
is negative, it indicates the client to filter rate
less messages/second
[in] | rate | the reported filter rate adjustment value. |
|
virtual |
This API is invoked when the service status changes for example when a subsytem restart (SSR) occurs
[in] | status | - telux::common::ServiceStatus |
class telux::cv2x::ICv2xThrottleManager |
ThrottleManager provides throttle manager client interface.
ThrottleManager provides APIs that allows applications to specify the incoming verification load on the system. This is used to make decisions on how to optimally use the resources available in the system. The API also provides feedback to clients on the suggested filtering that needs to be done when the incoming message verification rate exceeds the instantaneous system capacity.
Public Member Functions | |
virtual telux::common::ServiceStatus | getServiceStatus ()=0 |
virtual telux::common::Status | registerListener (std::weak_ptr< ICv2xThrottleManagerListener > listener)=0 |
virtual telux::common::Status | deregisterListener (std::weak_ptr< ICv2xThrottleManagerListener > listener)=0 |
virtual telux::common::Status | setVerificationLoad (int load, setVerificationLoadCallback cb)=0 |
virtual | ~ICv2xThrottleManager () |
|
virtual |
|
pure virtual |
This status indicates whether the object is in a usable state.
|
pure virtual |
Registers a listener to receive the updated filer rate adjustment data.
[in] | listener | - Listener that implement ICv2xThrottleManagerListener interface. |
|
pure virtual |
Deregister a ICv2xThrottleManagerListener.
[in] | listener | - Previously registered Cv2xThrottleManagerListener that is deregistered. |
|
pure virtual |
Set current measured/average verification load.
[in] | load | - current measured verification load(verification/second). |
[in] | cb | - callack for indicating the result of set verfication load. |
class telux::cv2x::ICv2xTxFlow |
This is class encapsulates a Cv2xRadio Tx flows. It contains the Tx socket associated with the flow through which client applications can send data. This class is referenced in ICv2xRadio::createTxSpsFlow, ICv2xRadio::createTxEventFlow, and ICv2xRadio::closeTxFlow
Public Member Functions | |
virtual uint32_t | getFlowId () const =0 |
virtual TrafficIpType | getIpType () const =0 |
virtual uint32_t | getServiceId () const =0 |
virtual int | getSock () const =0 |
virtual struct sockaddr_in6 | getSockAddr () const =0 |
virtual uint16_t | getPortNum () const =0 |
virtual | ~ICv2xTxFlow () |
|
virtual |
|
pure virtual |
Accessor for flow ID. The flow ID should be unique within a process but will not be unique between processes.
|
pure virtual |
Accessor for IP traffic type
|
pure virtual |
Accessor for service ID
|
pure virtual |
Accessor for the socket file descriptor
|
pure virtual |
Accessor for the socket address description
|
pure virtual |
Accessor for the flow's source port number
class telux::cv2x::ICv2xTxRxSocket |
This is class encapsulates a Cv2xRadio socket for both Tx and Rx. It contains the socket through which client applications can send and receive data. This class is referenced in ICv2xRadio::createCv2xTcpSocket and ICv2xRadio::closeCv2xTcpSocket.
Public Member Functions | |
virtual uint32_t | getId () const =0 |
virtual uint32_t | getServiceId () const =0 |
virtual int | getSocket () const =0 |
virtual struct sockaddr_in6 | getSocketAddr () const =0 |
virtual uint16_t | getPortNum () const =0 |
virtual | ~ICv2xTxRxSocket () |
|
virtual |
|
pure virtual |
Accessor for Cv2xRadio socket ID. The socket ID should be unique within a process but will not be unique between processes.
|
pure virtual |
Accessor for service ID
|
pure virtual |
Accessor for the socket file descriptor
|
pure virtual |
Accessor for the socket address description
|
pure virtual |
Accessor for the local port number bound to the socket
class telux::cv2x::ICv2xTxStatusReportListener |
Listeners for CV2X Tx status report must implement this interface.
Public Member Functions | |
virtual void | onTxStatusReport (const TxStatusReport &info) |
virtual | ~ICv2xTxStatusReportListener () |
|
virtual |
Destructor for ICv2xTxStatusReportListener
|
virtual |
Called when a CV2X transport block is transmitted in low layer if a listener for Tx status report has been registered by calling ICv2xRadio::registerTxStatusReportListener.
[in] | info | - Tx status of the transport block. |
class telux::cv2x::Cv2xUtil |
Cv2x utility class
Static Public Member Functions | |
static uint8_t | priorityToTrafficClass (Priority priority) |
static Priority | TrafficClassToPriority (uint8_t trafficClass) |
|
static |
This function is called to convert cv2x flow priority to traffic class. The Traffic Class indicates class or priority of IPv6 packet. If congestion occurs then packets with least priority will be discarded(See RFC2460 section-7). The result of this method is to fill the IPv6 header traffic class field, it is usually called just before sending IPv6 packet.
[in] | priority | - cv2x flow priority |
|
static |
This function is called to convert IPv6 packet traffic class to cv2x flow priority. The Traffic Class indicates class or priority of IPv6 packet. If congestion occurs then packets with least priority will be discarded(See RFC2460 section-7). It is to get the corresponding cv2x flow priority of the received packets, which usually being called when a new IPv6 packet received.
[in] | trafficClass | - class or priority of IPv6 packet(See RFC2460 section-7) |
using telux::cv2x::RxMetaDataValidity = typedef uint32_t |
using telux::cv2x::setVerificationLoadCallback = typedef std::function<void (telux::common::ErrorCode error)> |
This function is called as a response to ICv2xThrottleManager::setVerificationLoad
[in] | error | - SUCCESS if verification load was set successfully
|
|
strong |
|
strong |
Defines possible values for CV2X radio RX/TX status.
Enumerator | |
---|---|
INACTIVE |
RX/TX is inactive |
ACTIVE |
RX/TX is active |
SUSPENDED |
RX/TX is suspended |
UNKNOWN |
RX/TX status unknown |
|
strong |
Defines possible values for cause of CV2X radio failure. The cause code is only associated with cv2x suspend/inactive status, if cv2x is active, the cause code has no meaning. Used in Cv2xStatus
Enumerator | |
---|---|
TIMING |
CV2X is suspended due to the outage of timing reference. |
CONFIG |
CV2X is inactive due to v2x.xml is missing, invalid, or expired. |
UE_MODE |
CV2X is inactive due to CV2X mode is not started. |
GEOPOLYGON |
CV2X is inactive due to UE enters a geo-polygon that does not support cv2x. |
THERMAL |
CV2X is suspended when the device's temperature is high. |
THERMAL_ECALL |
CV2X is suspended when the device's temperature is high and emergency call is ongoing. |
GEOPOLYGON_SWITCH |
CV2X is suspended when UE switches to a new geopolygon that also supports CV2X and UE is already in CV2X active status, CV2X status will change to active after the update is done. |
SENSING |
CV2X Tx is suspended when GNSS signal recovers or CV2X mode just starts. UE needs sensing for 1 second before Tx can begin, Tx status will change to active after sensing is done. |
LPM |
CV2X is inactive when UE enters Low Power Mode. |
DISABLED |
CV2X is inactive due to CV2X is disabled in the EFS. |
NO_GNSS |
CV2X is inactive due to GNSS signal is not available when starting CV2X. |
INVALID_LICENSE |
CV2X is inactive due to invalid license. |
UNKNOWN |
Invalid cause type only used internally. |
|
strong |
|
strong |
Defines CV2X modes of concurrency with cellular WWAN.
Used in Cv2xRadioCapabilities
Enumerator | |
---|---|
WWAN_NONCONCURRENT |
No simultaneous WWAN + CV2X on this interface |
WWAN_CONCURRENT |
Interface supports requests for concurrent WWAN + CV2X connections. |
|
strong |
Defines CV2X status change events. The state can change in response to the loss of timing precision or a geofencing change.
Used in ICv2xRadioListener::onStatusChanged
Enumerator | |
---|---|
CV2X_INACTIVE | |
CV2X_ACTIVE | |
TX_SUSPENDED | |
TXRX_SUSPENDED |
|
strong |
Range of supported priority levels, where a lower number means a higher priority. For example, 8 is the current 3GPP standard.
Used in Cv2xRadioCapabilities and SpsFlowInfo
Enumerator | |
---|---|
MOST_URGENT | |
PRIORITY_1 | |
PRIORITY_2 | |
PRIORITY_3 | |
PRIORITY_4 | |
PRIORITY_5 | |
PRIORITY_6 | |
PRIORITY_BACKGROUND | |
PRIORITY_UNKNOWN |
|
strong |
Range of supported periodicities in milliseconds.
Used in Cv2xRadioCapabilities and SpsFlowInfo
Enumerator | |
---|---|
PERIODICITY_10MS | |
PERIODICITY_20MS | |
PERIODICITY_50MS | |
PERIODICITY_100MS | |
PERIODICITY_UNKNOWN |
|
strong |
V2X configuration source types listed in ascending order of priority. The system always uses the V2X configuration with the highest priority if multiple V2X configuration sources exist.
Used in ConfigEventInfo
Enumerator | |
---|---|
UNKNOWN |
V2X config file source is unknown |
PRECONFIG |
V2X config file source is preconfig |
SIM_CARD |
V2X config file source is SIM card |
OMA_DM |
V2X config file source is OMA-DM |
|
strong |
Defines possible values for the events relevant to CV2X config file.
Used in ConfigEventInfo
Enumerator | |
---|---|
CHANGED |
V2X config file is changed |
EXPIRED |
V2X config file is expired |
|
strong |
Fault detection for Tx chain that including PA and front end.
Used in RFTxInfo
Enumerator | |
---|---|
INACTIVE |
The Tx chain is not working. |
OPERATIONAL |
The Tx chain is operational. |
FAULT |
Fault detected on the Tx chain. |
|
strong |
Defines possible values for the segment type of a transport block.
Used in TxStatusReport
|
strong |
Defines new Tx or re-Tx type relevant to a transport block.
Used in TxStatusReport
Enumerator | |
---|---|
NEW_TX |
New Tx of the V2X transport block. |
RE_TX |
Re-Tx of the V2X transport block. |
Specify set of RX Meta data that contribute to received packet's meta data report. Used in RxPacketMetaDataReport
Enumerator | |
---|---|
RX_SUBFRAME_NUMBER |
Bit mask to specify whether sfn is valid in RxPacketMetaDataReport Bit mask to specify whether subChannelIndex is valid in RxPacketMetaDataReport |
RX_SUBCHANNEL_INDEX |
Bit mask to specify whether subChannelNum is valid in RxPacketMetaDataReport |
RX_SUBCHANNEL_NUMBER |
Bit mask to specify whether rssi0 is valid in RxPacketMetaDataReport |
RX_PRX_RSSI |
Bit mask to specify whether rssi1 is valid in RxPacketMetaDataReport |
RX_DRX_RSSI |
Bit mask to specify whether l2DestinationId is valid in RxPacketMetaDataReport |
RX_L2_DEST_ID |
Bit mask to specify whether sciFormat1Info is valid in RxPacketMetaDataReport |
RX_SCI_FORMAT1 |
Bit mask to specify whether delayEstimation is valid in RxPacketMetaDataReport |
RX_DELAY_ESTIMATION |
constexpr uint8_t telux::cv2x::MAX_ANTENNAS_SUPPORTED = 2u |
Defines Maximum number of antennas that is supported.
Used in TxStatusReport