EthIf产品参考手册
缩写词注解
缩写词 |
英文全称 |
中文解释 |
Eth |
Ethernet Driver (AUTOSAR BSW module) |
AUTOSAR标准以太网驱动模块 |
EthIf |
Ethernet Interface (AUTOSAR BSW module) |
AUTOSAR标准以太网接口模块 |
EthTrcv |
Ethernet Transceiver Driver (AUTOSAR BSW module) |
A UTOSAR标准以太网收发器模块 |
TCP |
Transmission Control Protocol |
传输控制协议 |
UDP |
User Datagram Protocol |
用户数据报协议 |
IP |
Internet Protocol |
以太网协议 |
简介
EthIf向上层提供与以太网硬件无关的独立接口，该接口可以支持多个不同的有线或无线以太网控制器和收发器。这些接口按功能可以大体分为模式控制相关的接口、时间同步相关的接口、数据接收发送相关的接口、EthIf本身的初始化或周期任务接口等。
图1-1 EthIf层次图
参考资料
[1] AUTOSAR_SWS_EthernetInterface.pdf，R19-11
功能描述
接口传递功能功能
接口传递功能介绍
EthIf负责对底层驱动提供给上层模块的接口进行抽象，通过EthDriver提供的接收发送接口实现对以太网数据的收发。
Vlan收发功能介绍
EthIf负责对VLAN报文的解/加Tag操作，当接收时，通过EthIf传递给上层的以太网报文将在EthIf中提取出VLAN头，并把剩余的数据传递给上层模块。当上层模块需要向下传输报文时，在EthIf中添加VLAN头，并通过合适的Eth通道发送出去。
状态通知功能介绍
EthIf负责向EthSM通知下层EthController和EthTrcv的状态变化。
源文件描述
表3-1 EthIf组件文件描述
文件 |
说明 |
EthIf_cfg.h |
定义EthIf模块预编译时用到的配置参数。 |
EthIf _cfg.c |
定义EthIf模块中链接时用到的配置参数。 |
EthIf.h |
EthIf模块头文 件，包含了API函数的扩展声明并定义了端口的数据结构。 |
EthIf.c |
DoIP模块源文件，包含了API函数的实现。 |
EthIf _Cbk.h |
包含EthIf供底层调用的API函数的声明。 |
EthIf_MemMap.h |
EthIf的内存映射定义。 |
EthIf_Types.h |
EthIf模块宏定义及数据类型定义。 |
图3-1 EthIf组件文件交互关系图
API接口
类型定义
EthIf_ConfigType类型定义
名称 |
EthIf_ConfigType |
类型 |
struct |
范围 |
无 |
描述 |
EthIf配置结构体定义 |
EthIf_EthDriverApiType类型定义
名称 |
EthIf_EthDriverApiType |
类型 |
struct |
范围 |
无 |
描述 |
EthIf通道对应的Eth驱动的API列表 |
EthIf_EthTrcvDriverApiType类型定义
名称 |
EthIf_EthTrcvDriverApiType |
类型 |
struct |
范围 |
无 |
描述 |
EthIf通道对应的EthTrcv驱动的API列表 |
输入函数描述
输入模块 |
API |
Eth.h |
Eth_Get-ControllerMode |
Eth_GetPhys-Addr |
|
Eth_ProvideTx-Buffer |
|
Eth_Set-ControllerMode |
|
Eth_Transmit |
|
Eth_Tx-Confirmation |
|
EthSM.h |
EthSM_Ctrl-ModeIndication |
EthSM_Trcv-LinkStateChg |
|
EthTrcv.h |
EthTrcv_Get-LinkState |
EthTrcv_Get-Transceiver-Mode |
|
EthTrcv_Set-Transceiver-Mode |
静态接口函数定义
EthIf_Init函数定义
函数名称： |
EthIf_Init |
||
函数原型： |
void EthIf_Init ( const E thIf_ConfigType* CfgPtr ) |
||
服务编号： |
0x01 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CfgPtr |
值域： |
Points to the implementation specific structure |
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
无 |
||
功能概述： |
EthIf初始化 |
EthIf_SetControllerMode函数定义
函数名称： |
EthIf_ SetControllerMode |
||
函数原型： |
Std_ReturnType EthIf_ SetControllerMode ( uint8 CtrlIdx, Eth_ModeType CtrlMode ) |
||
服务编号： |
0x03 |
||
同步/异步： |
异步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
CtrlMode |
值域： |
ETH_MODE_DOWN： disable the controller ETH_MODE_ACTIVE： enable the controller |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
Std_ReturnType E_OK： success E_NOT_OK： controller mode could not be changed |
||
功能概述： |
设 置controller模式 |
EthIf_GetControllerMode函数定义
函数名称： |
EthIf_ GetControllerMode |
||
函数原型： |
Std_ReturnType EthIf_GetCon trollerMode(uint8 CtrlI dx,Eth_ModeType* CtrlModePtr ) |
||
服务编号： |
0x04 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
输入 输出参数： |
无 |
||
输出参数： |
CtrlModePtr |
值域： |
ETH_MODE_DOWN： the controller is disabled ETH_MODE_ACTIVE： the controller is enabled |
返回值： |
Std_ReturnType E_OK： success E_NOT_OK： controller could not be initialized |
||
功能概述： |
获 取controller模式 |
EthIf_SetTransceiverWakeupMode函数定义
函数名称： |
EthIf_SetTran sceiverWakeupMode |
||
函数原型： |
Std_ReturnType EthIf_SetTran sceiverWakeupMode ( uint8 TrcvIdx, EthTr cv_WakeupModeType TrcvWakeupMode ) |
||
服务编号： |
0x2e |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
TrcvIdx |
值域： |
Index of the transceiver within the context of the Ethernet Interface |
TrcvWakeupMode |
值域： |
ETHTRCV_WUM_DISABLE： disable transceiver wake up ETHTRCV_WUM_ENABLE： enable transceiver wake up ETHTRCV_WUM_CLEAR： clears transceiver wake up reason |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
Std_ReturnType E_OK： success E_NOT_OK： transceiver wake up could not be changed or wake-up reason could not be cleared |
||
功能概述： |
设置Tr ansceiver唤醒模式 |
EthIf_GetTransceiverWakeupMode函数定义
函数名称： |
EthIf_GetTran sceiverWakeupMode |
||
函数原型： |
Std_ReturnType EthIf_GetTran sceiverWakeupMode ( uint8 TrcvIdx, EthTrcv _WakeupModeType* TrcvWakeupModePtr ) |
||
服务编号： |
0x2e |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
TrcvIdx |
值域： |
Index of the transceiver within the context of the Ethernet Interface |
输入 输出参数： |
无 |
||
输出参数： |
TrcvWakeupMode |
值域： |
ETHTRCV_WUM_DISABLE： transceiver wake up is disable TRCV_WUM_ENABLE： transceiver wake up is enable |
返回值： |
Std_ReturnType E_OK： success E_NOT_OK： transceiver wake up mode could not be obtained |
||
功能概述： |
获取Tr ansceiver唤醒模式 |
EthIf_CheckWakeup函数定义
函数名称： |
EthIf_CheckWakeup |
||
函数原型： |
Std_ReturnType EthIf_CheckWakeup ( EcuM _WakeupSourceType WakeupSource ) |
||
服务编号： |
0x30 |
||
同步/异步： |
异步 |
||
是 否可重入： |
可重入 |
||
输入参数： |
WakeupSource |
值域： |
source (transceiver) which initiated the wake up event |
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
Std_Return-Type E_OK when function has been successfully executed E_NOT_OK when function could not be successfully executed |
||
功能概述： |
判断Wakeup状态 |
EthIf_GetTransceiverMode函数定义
函数名称： |
EthIf_G etTransceiverMode |
||
函数原型： |
Std_ReturnType EthIf_Ge tTransceiverMode( uint8 CtrlIdx, E thTrcv_ModeType* TrcvModePtr ) |
||
服务编号： |
0x07 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
输入 输出参数： |
无 |
||
输出参数： |
TrcvModePtr |
值域： |
ETHTRCV_MODE_DOWN： the transceiver is disabled ETHTRCV_MODE_ACTIVE： the transceiver is enabled |
返回值： |
Std_ReturnType E_OK： success E_NOT_OK： transceiver mode could not be obtained |
||
功能概述： |
获 取transceiver状态 |
EthIf_ProvideTxBuffer函数定义
函数名称： |
EthI f_ProvideTxBuffer |
||
函数原型： |
BufReq_ReturnType EthI f_ProvideTxBuffer ( uint8 CtrlIdx, Eth_FrameType FrameType, uint8 Priority, Eth_BufIdxType* BufIdxPtr, uint8** BufPtr, uint16* LenBytePtr ) |
||
服务编号： |
0x09 |
||
同步/异步： |
同步 |
||
是 否可重入： |
可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
FrameType |
值域： |
Ethernet Frame Type (EtherType) |
|
Priority |
值域： |
Priority value which shall be used for the 3-bit PCP field of the VLAN tag |
|
输入 输出参数： |
LenBytePtr |
值域： |
in： desired length in bytes, out： granted length in bytes |
输出参数： |
BufIdxPtr |
值域： |
Index to the granted buffer resource. To be used for subsequent requests |
BufPtr |
值域： |
Pointer to the granted buffer |
|
返回值： |
Std_ReturnType BUFREQ_OK： success BUFREQ_E_NOT_OK： development error detected BUFREQ_E_BUSY： all buffers in use BUFREQ_E_OVFL： requested buffer too large |
||
功能概述： |
提供发送buffer |
EthIf_Transmit函数定义
函数名称： |
EthIf_Transmit |
||
函数原型： |
Std_ReturnType EthIf_Transmit ( uint8 CtrlIdx, Eth_BufIdxType BufIdx, Eth_FrameType FrameType, boolean TxConfirmation, uint16 LenByte, const uint8* PhysAddrPtr ) |
||
服务编号： |
0x0a |
||
同步/异步： |
同步 |
||
是 否可重入： |
不同的Ctrl Idx和BufIdx可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
BufIdx |
值域： |
Index of the buffer resource |
|
FrameType |
值域： |
Ethernet frame type |
|
TxConfirmation |
值域： |
Activates transmission confirmation |
|
LenByte |
值域： |
Data length in byte |
|
PhysAddrPtr |
值域： |
Physical target address (MAC address) in network byte order |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
Std_ReturnType E_OK： success E_NOT_OK： transmission failed |
||
功能概述： |
发送函数 |
EthIf_TxConfirmation函数定义
函数名称： |
Eth If_TxConfirmation |
||
函数原型： |
void Eth If_TxConfirmation ( uint8 CtrlIdx, Eth_BufIdxType BufIdx, Std_ReturnType Result ) |
||
服务编号： |
0x11 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
BufIdx |
值域： |
Index of the transmitted buffer |
|
Result |
值域： |
E_OK： The transmission was successful, E_NOT_OK： The transmission failed. |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
无 |
||
功能概述： |
发送确认函数 |
EthIf_RxIndication函数定义
函数名称： |
E thIf_RxIndication |
||
函数原型： |
void E thIf_RxIndication ( uint8 CtrlIdx, Eth_FrameType FrameType, boolean IsBroadcast, const uint8* PhysAddrPtr, const Eth_DataType* DataPtr, uint16 LenByte ) |
||
服务编号： |
0x10 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
FrameType |
值域： |
Frame type of received Ethernet frame |
|
IsBroadcast |
值域： |
parameter to indicate a broadcast frame |
|
PhysAddrPtr |
值域： |
Pointer to Physical source address (MAC address in network byte order) of received Ethernet frame |
|
DataPtr |
值域： |
Pointer to payload of received Ethernet frame. |
|
LenByte |
值域： |
Length (bytes) of the payload in received frame. |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
无 |
||
功能概述： |
接收通知函数 |
EthIf_SetPhysAddr函数定义
函数名称： |
EthIf_SetPhysAddr |
||
函数原型： |
void EthIf_SetPhysAddr ( uint8 CtrlIdx, const uint8* PhysAddrPtr ) |
||
服务编号： |
0x0d |
||
同步/异步： |
同步 |
||
是 否可重入： |
相同 的CtrlIdx不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
PhysAddrPtr |
值域： |
Pointer to memory containing the physical source address (MAC address) in network byte order. |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
无 |
||
功能概述： |
设置phy地址 |
EthIf_GetPhysAddr函数定义
函数名称： |
EthIf_GetPhysAddr |
||
函数原型： |
void EthIf_GetPhysAddr ( uint8 CtrlIdx, uint8* PhysAddrPtr ) |
||
服务编号： |
0x08 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
输入 输出参数： |
无 |
||
输出参数： |
PhysAddrPtr |
值域： |
Pointer to memory containing the physical source address (MAC address) in network byte order. |
返回值： |
无 |
||
功能概述： |
获取phy地址 |
EthIf_UpdatePhysAddrFilter函数定义
函数名称： |
EthIf_Upd atePhysAddrFilter |
||
函数原型： |
Std_ReturnType EthIf_Upd atePhysAddrFilter ( uint8 CtrlIdx, const uint8* PhysAddrPtr, Eth _FilterActionType Action ) |
||
服务编号： |
0x08 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
PhysAddrPtr |
值域： |
Pointer to memory containing the physical source address (MAC address) in network byte order. |
|
Action |
值域： |
Add or remove the address from the Ethernet controllers filter. |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
Std_ReturnType E_OK： filter was successfully changed E_NOT_OK： filter could not be changed |
||
功能概述： |
更 新phy地址到过滤器 |
EthIf_GetCurrentTime函数定义
函数名称： |
Eth If_GetCurrentTime |
||
函数原型： |
Std_ReturnType Eth If_GetCurrentTime ( uint8 CtrlIdx, Eth_Ti meStampQualType* timeQualPtr, Et h_TimeStampType* timeStampPtr ) |
||
服务编号： |
0x22 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
输入 输出参数： |
无 |
||
输出参数： |
timeQualPtr |
值域： |
quality of HW time stamp, e.g. based on current drift |
timeStampPtr |
值域： |
current time stamp |
|
输入 输出参数： |
无 |
||
输出参数： |
无 |
||
返回值： |
Std_ReturnType E_OK： successful E_NOT_OK： failed |
||
功能概述： |
获取当前时间戳 |
EthIf_EnableEgressTimeStamp函数定义
函数名称： |
EthIf_Enab leEgressTimeStamp |
||
函数原型： |
void EthIf_Enab leEgressTimeStamp ( uint8 CtrlIdx, Eth_BufIdxType BufIdx ) |
||
服务编号： |
0x23 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
BufIdx |
值域： |
Index of the message buffer, where Application expects egress time stamping |
|
返回值： |
无 |
||
功能概述： |
启用出口时间戳 |
EthIf_GetEgressTimeStamp函数定义
函数名称： |
EthIf_G etEgressTimeStamp |
||
函数原型： |
Std_ReturnType EthIf_G etEgressTimeStamp ( uint8 CtrlIdx, Eth_BufIdxType BufIdx, Eth_Ti meStampQualType* timeQualPtr, Et h_TimeStampType* timeStampPtr ) |
||
服务编号： |
0x24 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
DataPtr |
值域： |
Pointer to the message buffer, where Application expects ingress time stamping |
|
输入 输出参数： |
无 |
||
输出参数： |
timeQualPtr |
值域： |
quality of HW time stamp, e.g. based on current drift |
timeStampPtr |
值域： |
current time stamp |
|
返回值： |
Std_Return-Type E_OK： success E_NOT_OK： failed to read time stamp. |
||
功能概述： |
获取出口时间戳 |
EthIf_GetIngressTimeStamp函数定义
函数名称： |
EthIf_Ge tIngressTimeStamp |
||
函数原型： |
Std_ReturnType EthIf_Ge tIngressTimeStamp ( uint8 CtrlIdx, Eth_BufIdxType BufIdx, Eth_Ti meStampQualType* timeQualPtr, Et h_TimeStampType* timeStampPtr ) |
||
服务编号： |
0x25 |
||
同步/异步： |
同步 |
||
是 否可重入： |
不可重入 |
||
输入参数： |
CtrlIdx |
值域： |
Index of the Ethernet controller within the context of the Ethernet Interface |
DataPtr |
值域： |
Pointer to the message buffer, where Application expects ingress time stamping |
|
输入 输出参数： |
无 |
||
输出参数： |
timeQualPtr |
值域： |
quality of HW time stamp, e.g. based on current drift |
timeStampPtr |
值域： |
current time stamp |
|
返回值： |
Std_Return-Type E_OK： success E_NOT_OK： failed to read time stamp. |
||
功能概述： |
获取入口时间戳 |
EthIf_MainFunctionRx函数定义
函数名称： |
EthIf_MainFunctionRx |
函数原型： |
void EthIf_MainFunctionRx ( void ) |
服务编号： |
0x20 |
同步/异步： |
无 |
是 否可重入： |
无 |
输入参数： |
无 |
输入 输出参数： |
无 |
输出参数： |
无 |
返回值： |
无 |
功能概述： |
EthIf模块 接收处理函数，轮询模式下检查新接收到数据并发出接收通知 |
EthIf_MainFunctionTx函数定义
函数名称： |
EthIf_MainFunctionTx |
函数原型： |
void EthIf_MainFunctionTx ( void ) |
服务编号： |
0x21 |
同步/异步： |
无 |
是 否可重入： |
无 |
输入参数： |
无 |
输入 输出参数： |
无 |
输出参数： |
无 |
返回值： |
无 |
功能概述： |
EthIf模块发送确认处理函数，在轮询模式下发出传输确认 |
EthIf_MainFunctionState函数定义
函数名称： |
EthIf_MainFunctionState |
函数原型： |
void EthIf_MainFunctionState ( void ) |
服务编号： |
0x21 |
同步/异步： |
无 |
是 否可重入： |
无 |
输入参数： |
无 |
输入 输出参数： |
无 |
输出参数： |
无 |
返回值： |
无 |
功能概述： |
EthIf模块状态处理函数，轮询不同的通信硬件（以太网收 发器，以太网交换机端口）相关信息，如链路状态、信号质量 |
配置
EthIfGeneral
图5-1 EthIfGeneral容器配置图
表5‑1属性描述
UI 名称 |
描述 |
|||
E thIfVl anUsed |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Switches the EthIf Vlan used ON or OFF. true： enabled (ON). false： disabled (OFF). |
|||
依赖关系 |
无 |
|||
E thIfDe vError Detect |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Switches the Default Error Tracer (Det) detection and notification ON or OFF. true： enabled (ON). false： disabled (OFF). |
|||
依赖关系 |
无 |
|||
EthI fEnabl eRxInt errupt |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables receive interrupt. |
|||
依赖关系 |
无 |
|||
EthI fEnabl eTxInt errupt |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables the transmit interrupt. |
|||
依赖关系 |
无 |
|||
EthI fGetBa udRate |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables GetBaudRate API. |
|||
依赖关系 |
无 |
|||
Et hIfGet Counte rState |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables GetCounterState API. |
|||
依赖关系 |
无 |
|||
Et hIfGet Transc eiverW akeupM odeApi |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables EthIf_Get TransceiverWakeupMode API |
|||
依赖关系 |
无 |
|||
EthI fGloba lTimeS upport |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables/Disables the Global Time APIs used amongst others by Global Time Synchronization over Ethernet. |
|||
依赖关系 |
无 |
|||
EthIf MainFu nction Period |
取值范围 |
0..INF |
默认取值 |
0.01 |
参数描述 |
Specifies the period of main function EthIf_MainFunctionRx and EthIf_MainFunctionTx in seconds. Ethernet Interface does not require this information but the BSW scheduler. |
|||
依赖关系 |
不能为0 |
|||
Et hIfMai nFunct ionRxT imeout |
取值范围 |
0..INF |
默认取值 |
0 |
参数描述 |
This parameter is deprecated and will be removed in future. Old description： Timeout in seconds after which the EthIf stops to receive frames in an EthIfMainFunctionRx period. Tags： atp.Status=obsolete atp.Stat usRevisionBegin=4.2.2 |
|||
依赖关系 |
无 |
|||
EthIfM axTrcv sTotal |
取值范围 |
1..255 |
默认取值 |
1 |
参数描述 |
Limits the total number of transceivers. |
|||
依赖关系 |
无 |
|||
EthIfP ublicC ddHead erFile |
取值范围 |
1..32 characters |
默认取值 |
#includ e”TCPIP.h” |
参数描述 |
Defines header files for callback functions which shall be included in case of CDDs. Range of characters is 1.. 32. |
|||
依赖关系 |
无 |
|||
Eth IfRxIn dicati onIter ations |
取值范围 |
0 .. 65535 |
默认取值 |
10 |
参数描述 |
Maximum number of Ethernet frames per Ethernet controller polled from the Ethernet driver within EthIf_MainFunctionRx. |
|||
依赖关系 |
无 |
|||
E nables / Di sables St artAut oNegot iation API |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables StartAutoNegotiation API |
|||
依赖关系 |
无 |
|||
E thIfTr cvLink StateC hgMain Reload |
取值范围 |
1..255 |
默认取值 |
1 |
参数描述 |
Specifies the frequency of transceiver link state change checks in each period of main function EthIf_MainFunctionTx. |
|||
依赖关系 |
无 |
|||
E thIfVe rsionI nfoApi |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables version info API |
|||
依赖关系 |
无 |
|||
EthIfV ersion InfoAp iMacro |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables version info API macro implementation. |
|||
依赖关系 |
无 |
|||
EthIfW akeUpS upport |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Configures if wakeup is supported or not |
|||
依赖关系 |
无 |
|||
E thIfGe tCtrlI dxList |
取值范围 |
STD_ON / STD_OFF |
默认取值 |
STD_OFF |
参数描述 |
Enables / Disables GetCtrlIdxList API. |
|||
依赖关系 |
无 |
|||
EthI fMainF unctio nState Period |
取值范围 |
0..INF |
默认取值 |
0.01 |
参数描述 |
Specifies the period of main function Et hIf_MainFunctionState in seconds. Ethernet Interface does not require this information but the BSW scheduler. |
|||
依赖关系 |
无 |
EthIfConfigSet
图5-2EthIfConfigSet容器配置图
表5‑2属性描述
UI 名称 |
描述 |
|||
Eth IfCont roller |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
This container contains the configuration of EthIfController. |
|||
依赖关系 |
配置中最少有一个 EthIfController， 定义的配置数组名为 Et hIf_ControllerCfgData |
|||
Eth IfFram eOwner Config |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
Configuration of Ethernet frame owner |
|||
依赖关系 |
配置中最少有两 个EtherIfFrameOwnerCo nfig，分别对应ARP和IP |
|||
EthIf RxIndi cation Config |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
Configuration of receive callback functions. |
|||
依赖关系 |
无 |
|||
EthIf Switch |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
This container contains the configuration of EthIfSwitches. |
|||
依赖关系 |
无 |
|||
Eth IfTrcv LinkSt ateChg Config |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
Specifies link state change callback function |
|||
依赖关系 |
无 |
|||
E thIfTx Confir mation Config |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
Configuration of transmit indication callback functions. |
|||
依赖关系 |
无 |
|||
E thIfPh ysCont roller |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
This container contains the configuration of EthIfPhysController. The usage of EthIfEthCtrlRef and EthIfWEthCtrlRef is exclusive OR. |
|||
依赖关系 |
无 |
|||
EthI fTrans ceiver |
取值范围 |
Container |
默认取值 |
无 |
参数描述 |
This container contains the configuration of EthIfTransceiver. The usage of EthIfEthTrcvRef and EthIfWEthTrcvRefis exclusive OR. |
|||
依赖关系 |
无 |
EthIfController
图5-3 EthIfController容器配置图
表5‑3属性描述
UI 名称 |
描述 |
|||
EthIfC trlIdx |
取值范围 |
0..255 |
默认取值 |
无 |
参数描述 |
This parameter provides a zero-based consecutive index of the Ethernet Communication Controllers. Upper layer BSW modules and the EthIf itself use this index to identify a Ethernet CC. |
|||
依赖关系 |
新增时自动 递增，删除时自动递减 |
|||
EthIfC trlMtu |
取值范围 |
64..9000 |
默认取值 |
1500 |
参数描述 |
Specifies the maximum transmission unit (MTU) of the EthIfCtrl in [bytes]. Note： in case a VLAN tag is used for the EthIfCtrl, the MTU is 4 bytes smaller han the maximum payload size of an Ethernet frame which can be transmitted on the network. |
|||
依赖关系 |
新增时自动 递增，删除时自动递减 |
|||
E thIfMa xTxBuf sTotal |
取值范围 |
1..255 |
默认取值 |
4 |
参数描述 |
Limits the total number of transmit buffers. |
|||
依赖关系 |
无 |
|||
EthIf VlanId |
取值范围 |
0..4095 |
默认取值 |
0 |
参数描述 |
A virtual-LAN is identified by this attribute according to IEEE 802.1Q |
|||
依赖关系 |
如果EthIf VlanUsed配置成STD_OFF 的情况下，VLANID生成0 xff，并且这时候不可配 |
|||
E thIfPh ysCont roller |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
This container contains the configuration of EthIfPhysController. The usage of EthIfEthCtrlRef and EthIfWEthCtrlRef is exclusive OR. |
|||
依赖关系 |
指向 EthIf_PhysCont rollerCfg结构体的实例 |
|||
EthIfT rcvRef |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
Reference to a Ethernet Transceiver. |
|||
依赖关系 |
引用到EthIf TrcvCfg的具体实例，关 联到EthIfTransceiver |
EthIfFrameOwnerConfig
图5-4 EthIfFrameOwerConfig容器配置图
表5‑4EthIfFrameOwerConfig属性描述
UI 名称 |
描述 |
|||
Et hIfFra meType |
取值范围 |
0 .. 65535 |
默认取值 |
无 |
参数描述 |
Selects the Ethernet frame type. |
|||
依赖关系 |
无 |
|||
EthI fOwner |
取值范围 |
0 .. 255 |
默认取值 |
0 |
参数描述 |
Selects the owner of an Ethernet frame type. The owner is a zero based index into the callback function configuration ‘EthI fRxIndicationConfig’. I.e. an Ethernet frame of type IPv4 (0x800) at index 0 will call the first callback function configured in ‘EthI fRxIndicationConfig’. |
|||
依赖关系 |
配置的值 不能超过EthIfRxIndic ationConfig的配置个数 |
EthIfPhysController
图5-5 EthIfPhysController容器配置图
表5‑5 EthIfPhysController属性描述
UI 名称 |
描述 |
|||
EthI fPhysC ontrol lerIdx |
取值范围 |
0 .. 255 |
默认取值 |
无 |
参数描述 |
This parameter provides a zero-based consecutive index of the physical Ethernet controllers. Upper layer BSW modules and the Ethernet Interface itself use this index to identify a physical Ethernet controller. |
|||
依赖关系 |
新增时自动 递增，删除时自动递减 |
|||
Eth IfEthC trlRef |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
关联到EthI fEthCtrlRef的具体实现 |
|||
依赖关系 |
无 |
EthIfRxIndicationConfig
图5-6 EthIfRxIdicationConfig容器配置图
表5‑6 EthIfRxIdicationConfig属性描述
UI 名称 |
描述 |
|||
E thIfRx Indica tionFu nction |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
Specifies receive indication callback function. |
|||
依赖关系 |
无 |
EthIfSwitch
图5-7 EthIfSwitch容器配置图
表5‑7 EthIfSwitch属性描述
UI 名称 |
描述 |
|||
Et hIfSwi tchIdx |
取值范围 |
0 .. 255 |
默认取值 |
无 |
参数描述 |
This parameter provides a zero-based consecutive index of the Ethernet Interface Switches. Upper layer BSW modules and the EthIf itself use this index to identify a Ethernet Switch. |
|||
依赖关系 |
新增时自动 递增，删除时自动递减 |
|||
Et hIfSwi tchRef |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
Reference to a Ethernet Switch, which is handled by a specific Ethernet Switch driver. |
|||
依赖关系 |
无 |
EthIfTrcvLinkStateChgConfig
图5-8 EthIfTrcvLinkStateChgConfig容器配置图
表5‑8 EthIfTrcvLinkStateChgConfig属性描述
UI 名称 |
描述 |
|||
EthIf TrcvLi nkStat eChgFu nction |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
Specifies link state change callback function |
|||
依赖关系 |
无 |
EthIfTxConfirmationConfig
图5-9 EthIfTxConfirmationConfig容器配置图
表5‑9 EthIfTxConfirmationConfig属性描述
UI 名称 |
描述 |
|||
Eth IfTxCo nfirma tionFu nction |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
Specifies transmit indication callback function |
|||
依赖关系 |
无 |
EthIfTransceiver
图5-10 EthIfTransceiver容器配置图
表5‑10 EthIfTransceiver属性描述
UI 名称 |
描述 |
|||
E thIfTr anscei verIdx |
取值范围 |
0 .. 255 |
默认取值 |
无 |
参数描述 |
This parameter provides a zero-based consecutive index of the Ethernet transceivers. Upper layer BSW modules and the Ethernet Interface itself use this index to identify an Ethernet tranceiver. |
|||
依赖关系 |
新增时自动 递增，删除时自动递减 |
|||
Eth IfEthT rcvRef |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
关联到EthI fEthTrcvRef的具体实现 |
|||
依赖关系 |
无 |
EthTrcv_DriverApi
图5-11 EthTrcv_DriverApi容器配置图
表5‑11 EthTrcv_DriverApi属性描述
UI 名称 |
描述 |
|||
Et hTrcvN ameRef |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
R ef到EthTrcv驱动的名称 |
|||
依赖关系 |
引用 的EthTrcvName不能相同 |
|||
Et hTrcv_ SetTra nsceiv erWake upMode |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
|||
Et hTrcv_ GetTra nsceiv erWake upMode |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
|||
EthTr cv_Tra nsceiv erLink StateR equest |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
|||
Et hTrcv_ GetTra nsceiv erMode |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
|||
Et hTrcv_ GetLin kState |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
|||
Et hTrcv_ SetTra nsceiv erMode |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
|||
E thTrcv _Check Wakeup |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根据E thTrcvNameRef自动变更 |
Eth_DriverApi
图5-12 Eth_DriverApi容器配置图
表5‑12 Eth_DriverApi属性描述
UI 名称 |
描述 |
|||
EthN ameRef |
取值范围 |
Ref |
默认取值 |
无 |
参数描述 |
Ref 到EthDriver驱动的名称 |
|||
依赖关系 |
引用的EthName不能相同 |
|||
Eth_Se tContr ollerM odeApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth_Ge tContr ollerM odeApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth_ Provid eTxBuf ferApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth _Trans mitApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth_Se tPhysA ddrApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth_Ge tPhysA ddrApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth _Updat ePhysA ddrFil terApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth _GetCu rrentT imeApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth_ Enable Egress TimeSt ampApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
E th_Get Egress TimeSt ampApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Et h_GetI ngress TimeSt ampApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Et h_Rece iveApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |
|||
Eth _TxCon firmat ionApi |
取值范围 |
FunctionName |
默认取值 |
无 |
参数描述 |
API名 |
|||
依赖关系 |
可根 据EthNameRef自动变更 |