以太網PHY驅動軟件配置

這里以Renesas提供的RZ/T2M工程樣例“RZT2M_EtherCAT_RSK_rev0100”為例對PHY驅動的軟件配置流程進行說明。此工程樣例可以在Renesas提供的開發版上運行和調試。開發套件的使用文件《r20ut4939eg0050-rskrzt2m-usermanual_c.pdf》可以上Renesas官方網站上獲取，開發板也可以申請購買或者是借用。

驅動配置的入口

void hal_entry (void)
{
  fsp_err_t err;
  /* TODO: add your own code here */
  /* Initialize EtherCAT SSC Port */
  err = RM_ETHERCAT_SSC_PORT_Open(gp_ethercat_ssc_port->p_ctrl, gp_ethercat_ssc_port->p_cfg);
  if(FSP_SUCCESS != err)
  {
    __BKPT(0); /* Can't continue the stack */
  }
  ...
}

進入RM_ETHERCAT_SSC_PORT_Open(), 這個EtherCAT接口配置函數之后，可以看到EtherCAT Slave Controller的一些初始化配置，其中就包括了PHY的初始化：

/* Open Ether-Phy Driver */
for (i = 0; BSP_FEATURE_ESC_MAX_PORTS > i; i++)
{
  p_ether_PHY_instance = (ether_PHY_instance_t *) p_extend->p_ether_PHY_instance[i];
  if (NULL != p_ether_PHY_instance)
  {
    err = p_ether_PHY_instance->p_api->open(p_ether_PHY_instance->p_ctrl, p_ether_PHY_instance->p_cfg);
  }
  if (FSP_SUCCESS == err)
  {
    opened_PHY[i] = 1;
  }
  else
  {
    break;
  }
}

PHY驅動配置相關數據結構解析

這里初始化的一個PHY實例是：

p_ether_PHY_instance，它是一個ether_PHY_instance_t類型的變量。

typedef struct st_ether_PHY_instance
{
  ether_PHY_ctrl_t   * p_ctrl;  ///< Pointer to the control structure for this instance
 ? ?ether_PHY_cfg_t const * p_cfg; ? ? ///< Pointer to the configuration structure for this instance
 ? ?ether_PHY_api_t const * p_api; ? ? ///< Pointer to the API structure for this instance
} ether_PHY_instance_t;

其中ether_PHY_ctrl_t是指向PHY實例的控制結構體；

ether_PHY_cfg_t是指向實例配置的結構體指針;

ether_PHY_api_t是實例配置過程中需要調用到的函數方法所組成的結構體指針;

這個PHY的實例是在調用RM_ETHERCAT_SSC_PORT_Open（）函數的時候形參傳遞進來的，也就是gp_ethercat_ssc_port。

ethercat_ssc_port_instance_t const * gp_ethercat_ssc_port = &g_ethercat_ssc_port0;

而gp_ethercat_ssc_port這個ethercat_ssc_port_instance_t類型的全局指針是指向一個常量，也就是下面代碼中的g_ethercat_ssc_port0。

/* Instance structure to use this module. */
const ethercat_ssc_port_instance_t g_ethercat_ssc_port0 =
{
  .p_ctrl    = &g_ethercat_ssc_port0_ctrl,
  .p_cfg     = &g_ethercat_ssc_port0_cfg,
  .p_api     = &g_ethercat_ssc_port_on_ethercat_ssc_port
};

可以看到g_ethercat_ssc_port0是一個常量結構體，它的成員變量分別是：

g_ethercat_ssc_port0_ctrl指向ethercat_ssc_port0控制結構體指針；

g_ethercat_ssc_port0_cfg指向ethercat_ssc_port0配置結構體指針；

g_ethercat_ssc_port_on_ethercat_ssc_port指向ethercat_ssc_port0配置方法的結構指針。

看到這里是不是有一種似成相識的感覺？g_ethercat_ssc_port0是對ethercat_ssc_port0這個外設的驅動的描述體，與前面PHY驅運的描述體“p_ether_PHY_instance”結構上很相似，其實工程樣例中所有的外設驅動都可以使用類似的結構體去完成相應的初始化。比如說timer驅動描述結構體：

/** This structure encompasses everything that is needed to use an instance of this interface. */
typedef struct st_timer_instance
{
  timer_ctrl_t   * p_ctrl;    ///< Pointer to the control structure for this instance
 ? ?timer_cfg_t const * p_cfg; ? ? ? ? ///< Pointer to the configuration structure for this instance
 ? ?timer_api_t const * p_api; ? ? ? ? ///< Pointer to the API structure for this instance
} timer_instance_t;

這種相似的驅動描述體其實就是工程樣例驅動代碼部分的大致框架所在，撐握了這個脈絡即可以方便的看懂其它外設驅動的代碼，也可以在以后的驅動開發過程中參考這種框架，提升代的通用性和可讀性。

我們知道PHY的驅動是ethercat_ssc_port0外設驅動的子模塊。因為要在RZ/T2M這個芯片上使能EtherCAT功能塊，除了要完成芯片本身相關外設的初始化之外，還要完成與之對應的PHY的初始化。那么兩者是如何關聯在一起的呢？我們繼續解讀g_ethercat_ssc_port0這個全局結構體。可以看到g_ethercat_ssc_port0_cfg所指向的內容是配置ethercat_ssc_port0的描述體，如下所示：

/** Configuration parameters. */
typedef struct st_ethercat_ssc_port_cfg
{
  uint32_t reset_hold_time;                    ///< PHY Reset signal hold time (ms)
 ? ?uint32_t reset_wait_time; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?///< Wait time after PHY reset relase (us)
 ? ?uint32_t offset_address; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< PHY offset PHYsical address


 ? ?IRQn_Type esc_cat_irq; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< EtherCAT IRQ interrupt number
 ? ?uint8_t ? esc_cat_ipl; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< EtherCAT interrupt priority


 ? ?IRQn_Type esc_sync0_irq; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?///< EtherCAT Sync0 IRQ interrupt number
 ? ?uint8_t ? esc_sync0_ipl; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< EtherCAT Sync0 interrupt priority


 ? ?IRQn_Type esc_sync1_irq; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?///< EtherCAT Sync1 IRQ interrupt number
 ? ?uint8_t ? esc_sync1_ipl; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< EtherCAT Sync1 interrupt priority
 ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?///< Callback provided when an ISR occurs
 ? ?void (* p_callback)(ethercat_ssc_port_callback_args_t * p_args); 


 ? ?timer_instance_t const * p_timer_instance; ? ? ? ? ? ? ? ? ? ///< Pointer to Timer instance


 ? ?/** Placeholder for user data. ?Passed to the user callback in ethercat_ssc_port_callback_args_t. */
 ? ?void const * p_context;
 ? ?void const * p_extend; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< Placeholder for user extension.
} ethercat_ssc_port_cfg_t;

對PHY的復位信號保持時間有描述，還有對EtherCAT中斷有作描述，在此不展開討論。其中p_extend成員是用戶用于擴展控制的占位符。這也正是PHY驅動與ethercat_ssc_port0驅動關聯的關鍵所在。代碼賦于這個占位符是一個指向擴展配置的結構體指針。具體可以看看這個結構體的內容如下：

/** Extended configuration */
typedef struct s_ethercat_ssc_port_extend_cfg
{
  ethercat_ssc_port_eeprom_size_t eeprom_size;             ///< EEPROM memory size
 ? ?ethercat_ssc_port_txc_delay_t ? txc0; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< Port 0 TXC delay time
 ? ?ethercat_ssc_port_txc_delay_t ? txc1; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< Port 1 TXC delay time
 ? ?ethercat_ssc_port_txc_delay_t ? txc2; ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ///< Port 2 TXC delay time


 ? ?ether_PHY_instance_t const * p_ether_PHY_instance[BSP_FEATURE_ESC_MAX_PORTS]; 
///< Pointer to ETHER_PHY instance
} ethercat_ssc_port_extend_cfg_t;
const ethercat_ssc_port_extend_cfg_t g_ethercat_ssc_port0_ext_cfg =
{
 ? ?.eeprom_size ? ? ? ? ? ? = ETHERCAT_SSC_PORT_EEPROM_SIZE_UNDER_32KBIT,
 ? ?.txc0 ? ? ? ? ? ? ? ? ? ?= ETHERCAT_SSC_PORT_TXC_DELAY_00NS,
 ? ?.txc1 ? ? ? ? ? ? ? ? ? ?= ETHERCAT_SSC_PORT_TXC_DELAY_00NS,
 ? ?.txc2 ? ? ? ? ? ? ? ? ? ?= ETHERCAT_SSC_PORT_TXC_DELAY_00NS,
 ? ?.p_ether_PHY_instance[0] =
#define FSP_NOT_DEFINED (1)
#if (FSP_NOT_DEFINED == g_ether_PHY0)
 ? ? ? ? ? ? ? ? ? ?NULL,
#else
 ? ? ? ? ? ? ? ? ? ?&g_ether_PHY0,
#endif
 ? ?.p_ether_PHY_instance[1] =
#if (FSP_NOT_DEFINED == g_ether_PHY1)
 ? ? ? ? ? ? ? ? ? ?NULL,
#else
 ? ? ? ? ? ? ? ? ? ?&g_ether_PHY1,
#endif
 ? ?.p_ether_PHY_instance[2] =
#if (FSP_NOT_DEFINED == FSP_NOT_DEFINED)
 ? ? ? ? ? ? ? ? ? ?NULL,
#else
 ? ? ? ? ? ? ? ? ? ?&FSP_NOT_DEFINED,
#endif
};

里面就對應有ether_PHY_instance_t類體的初始化值，這值的類型正好是PHY實例所對應的描體結構體如下代碼所示，所以關聯就產生了。

typedef struct st_ether_PHY_instance
{
  ether_PHY_ctrl_t   * p_ctrl;  ///< Pointer to the control structure for this instance
 ? ?ether_PHY_cfg_t const * p_cfg; ? ? ///< Pointer to the configuration structure for this instance
 ? ?ether_PHY_api_t const * p_api; ? ? ///< Pointer to the API structure for this instance
} wh wether_PHY_instance_t;

審核編輯：劉清