C Common APIs

Data Structures
struct	v2x_api_ver_t

Enumerations
enum	v2x_status_enum_type {   V2X_STATUS_SUCCESS = 0, V2X_STATUS_FAIL = 1, V2X_STATUS_ENO_MEMORY = 3, V2X_STATUS_EBADPARM = 4,   V2X_STATUS_EALREADY = 5, V2X_STATUS_KINETICS_PLACEHOLDER = 1000, V2X_STATUS_RADIO_PLACEHOLDER = 2000, V2X_STATUS_ECHANNEL_UNAVAILABLE = 2001,   V2X_STATUS_RADIO_NOT_READY = 2002, V2X_STATUS_VEHICLE_PLACEHOLDER = 3000 }

Detailed Description

This section contains C Common APIs related to Cellular-V2X operation.

The following common typedefs and macros are used by the C-V2X C APIs.

---

Data Structure Documentation

struct v2x_api_ver_t

Contains retrieved information about the SDK API library that is called. Each SDK component (Kinematics, Radio, Vehicle Data) implements a method to return this structure.

Data Fields
uint32_t	version_num	Version number of the interface.
char	build_date_str[128]	Date of the build (part of the data string).
char	build_time_str[128]	Time of the build (part of the data string).
char	build_details_str[128]	Build details (part of the data string).

Enumeration Type Documentation

enum v2x_status_enum_type

Valid types for subsystem status, and return status codes for API function calls and callbacks.

Enumerator
V2X_STATUS_SUCCESS	Operation is successful.
V2X_STATUS_FAIL	Operation is unsuccessful. This is a generic error failure status that can be due to radio hardware resource limitations, geofencing, and so on.
V2X_STATUS_ENO_MEMORY	Failure due to a memory allocation issue.
V2X_STATUS_EBADPARM	One of the supplied parameters is bad.
V2X_STATUS_EALREADY	Attempted step was already issued, and this call is not required.
V2X_STATUS_KINETICS_PLACEHOLDER	Begin the return codes associated with the Kinematics interface.
V2X_STATUS_RADIO_PLACEHOLDER	Begin the return codes associated with the Radio interface.
V2X_STATUS_ECHANNEL_UNAVAILABLE	Requested radio frequency cannot be used at this time.
V2X_STATUS_RADIO_NOT_READY	Radio initialization failed due to v2x status.
V2X_STATUS_VEHICLE_PLACEHOLDER	Begin the return codes associated with the Vehicle Data interface.