diff options
-rw-r--r-- | drivers/staging/silicom/bypasslib/libbp_sd.h | 183 |
1 files changed, 103 insertions, 80 deletions
diff --git a/drivers/staging/silicom/bypasslib/libbp_sd.h b/drivers/staging/silicom/bypasslib/libbp_sd.h index 405ca67..cac4b0b 100644 --- a/drivers/staging/silicom/bypasslib/libbp_sd.h +++ b/drivers/staging/silicom/bypasslib/libbp_sd.h @@ -39,53 +39,70 @@ int get_bypass_slave_sd(int if_index); * @if_index: network device index * * Output: - * flags word on success;flag word is a 32-bit mask word with each bit defines different - * capability as described bellow. + * flags word on success;flag word is a 32-bit mask word with each bit defines + * different capability as described bellow. * Value of 1 for supporting this feature. 0 for not supporting this feature. - * -1 - on failure (if the device is not capable of the operation or not a Bypass device) - * Bit feature description + * -1 - on failure (if the device is not capable of the operation or not a + * Bypass device) + * Bit feature description * - * 0 BP_CAP The interface is Bypass capable in general + * 0 BP_CAP The interface is Bypass capable in general * - * 1 BP_STATUS_CAP The interface can report of the current Bypass mode + * 1 BP_STATUS_CAP The interface can report of the current Bypass + * mode * - * 2 BP_STATUS_CHANGE_CAP The interface can report on a change to bypass mode from - * the last time the mode was defined + * 2 BP_STATUS_CHANGE_CAP The interface can report on a change to bypass + * mode from the last time the mode was defined * - * 3 SW_CTL_CAP The interface is Software controlled capable for bypass/non bypass modes. + * 3 SW_CTL_CAP The interface is Software controlled capable for + * bypass/non bypass modes. * - * 4 BP_DIS_CAP The interface is capable of disabling the Bypass mode at all times. - * This mode will retain its mode even during power loss and also after - * power recovery. This will overcome on any bypass operation due to - * watchdog timeout or set bypass command. + * 4 BP_DIS_CAP The interface is capable of disabling the Bypass + * mode at all times. This mode will retain its + * mode even during power loss and also after power + * recovery. This will overcome on any bypass + * operation due to watchdog timeout or set bypass + * command. * - * 5 BP_DIS_STATUS_CAP The interface can report of the current DIS_BP_CAP + * 5 BP_DIS_STATUS_CAP The interface can report of the current + * DIS_BP_CAP * - * 6 STD_NIC_CAP The interface is capable to be configured to operate as standard, non Bypass, - * NIC interface (have direct connection to interfaces at all power modes) + * 6 STD_NIC_CAP The interface is capable to be configured to + * operate as standard, non Bypass, NIC interface + * (have direct connection to interfaces at all + * power modes) * - * 7 BP_PWOFF_NO_CAP The interface can be in Bypass mode at power off state + * 7 BP_PWOFF_NO_CAP The interface can be in Bypass mode at power off + * state * - * 8 BP_PWOFF_OFF_CAP The interface can disconnect the Bypass mode at power off state without - * effecting all the other states of operation + * 8 BP_PWOFF_OFF_CAP The interface can disconnect the Bypass mode at + * power off state without effecting all the other + * states of operation * - * 9 BP_PWOFF_CTL_CAP The behavior of the Bypass mode at Power-off state can be controlled by - * software without effecting any other state + * 9 BP_PWOFF_CTL_CAP The behavior of the Bypass mode at Power-off + * state can be controlled by software without + * effecting any other state * - *10 BP_PWUP_ON_CAP The interface can be in Bypass mode when power is turned on - * (until the system take control of the bypass functionality) + *10 BP_PWUP_ON_CAP The interface can be in Bypass mode when power + * is turned on (until the system take control of + * the bypass functionality) * - *11 BP_PWUP_OFF_CAP The interface can disconnect from Bypass mode when power is turned on - * (until the system take control of the bypass functionality) + *11 BP_PWUP_OFF_CAP The interface can disconnect from Bypass mode + * when power is turned on (until the system take + * control of the bypass functionality) * - *12 BP_PWUP_CTL_CAP The behavior of the Bypass mode at Power-up can be controlled by software + *12 BP_PWUP_CTL_CAP The behavior of the Bypass mode at Power-up can + * be controlled by software * - *13 WD_CTL_CAP The interface has watchdog capabilities to turn to Bypass mode when not reset - * for defined period of time. + *13 WD_CTL_CAP The interface has watchdog capabilities to turn + * to Bypass mode when not reset for defined period + * of time. * - *14 WD_STATUS_CAP The interface can report on the watchdog status (Active/inactive) + *14 WD_STATUS_CAP The interface can report on the watchdog status + * (Active/inactive) * - *15 WD_TIMEOUT_CAP The interface can report the time left till watchdog triggers to Bypass mode. + *15 WD_TIMEOUT_CAP The interface can report the time left till + * watchdog triggers to Bypass mode. * *16-31 RESERVED * @@ -108,7 +125,8 @@ int get_bypass_caps_sd(int if_index); * * 4 WD_STEP_TIME The steps of the WD timer in * 0 - for linear steps (WD_MIN_TIME * X) - * 1 - for multiply by 2 from previous step (WD_MIN_TIME * 2^X) + * 1 - for multiply by 2 from previous step + * (WD_MIN_TIME * 2^X) * * 5-8 WD_STEP_COUNT Number of steps the WD timer supports in 2^X * (X bit available for defining the value) @@ -152,8 +170,8 @@ int get_bypass_change_sd(int if_index); * @dis_bypass: disable bypass(1=dis, 0=en) * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int set_dis_bypass_sd(int if_index, int dis_bypass); @@ -162,8 +180,8 @@ int set_dis_bypass_sd(int if_index, int dis_bypass); * @if_index: network device index of the controlling device * Output: * 0/1 - on success (normal Bypass mode/ Disable bypass) - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int get_dis_bypass_sd(int if_index); @@ -173,8 +191,8 @@ int get_dis_bypass_sd(int if_index); * @bypass_mode: bypass mode setting at power off state (1=BP en, 0=BP Dis) * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int set_bypass_pwoff_sd(int if_index, int bypass_mode); @@ -183,8 +201,8 @@ int set_bypass_pwoff_sd(int if_index, int bypass_mode); * @if_index: network device index of the controlling device * Output: * 0/1 - on success (Disable bypass at power off state / normal Bypass mode) - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int get_bypass_pwoff_sd(int if_index); @@ -194,8 +212,8 @@ int get_bypass_pwoff_sd(int if_index); * @bypass_mode: bypass mode setting at power up state (1=BP en, 0=BP Dis) * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int set_bypass_pwup_sd(int if_index, int bypass_mode); @@ -204,21 +222,22 @@ int set_bypass_pwup_sd(int if_index, int bypass_mode); * @if_index: network device index of the controlling device * Output: * 0/1 - on success (Disable bypass at power up state / normal Bypass mode) - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int get_bypass_pwup_sd(int if_index); /** * set_bypass_wd - Set watchdog state * @if_index: network device index of the controlling device - * @ms_timeout: requested timeout (in ms units), 0 for disabling the watchdog timer - * @ms_timeout_set(output): requested timeout (in ms units), - * that the adapter supports and will be used by the watchdog + * @ms_timeout: requested timeout (in ms units), 0 for disabling the watchdog + * timer + * @ms_timeout_set(output): requested timeout (in ms units), that the adapter + * supports and will be used by the watchdog * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int set_bypass_wd_sd(int if_index, int ms_timeout, int *ms_timeout_set); @@ -230,8 +249,8 @@ int set_bypass_wd_sd(int if_index, int ms_timeout, int *ms_timeout_set); * 0 if WDT is disabled * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int get_bypass_wd_sd(int if_index, int *ms_timeout_set); @@ -243,8 +262,8 @@ int get_bypass_wd_sd(int if_index, int *ms_timeout_set); * 0 if WDT is disabled * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device or unknown wdt status) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device or unknown wdt status) **/ int get_wd_expire_time_sd(int if_index, int *ms_time_left); @@ -255,8 +274,8 @@ int get_wd_expire_time_sd(int if_index, int *ms_time_left); * Output: * 1 - on success * 0 - watchdog is not configured - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device or unknown wdt status) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device or unknown wdt status) **/ int reset_bypass_wd_timer_sd(int if_index); @@ -267,8 +286,8 @@ int reset_bypass_wd_timer_sd(int if_index); * * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int set_std_nic_sd(int if_index, int nic_mode); @@ -278,8 +297,8 @@ int set_std_nic_sd(int if_index, int nic_mode); * * Output: * 0/1 (Default Bypass mode / Standard NIC mode) on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass or it's a slave device) **/ int get_std_nic_sd(int if_index); @@ -300,7 +319,8 @@ int set_tx_sd(int if_index, int tx_state); * * Output: * 0/1 (ransmit Disable / Transmit Enable) on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass) + * -1 - on failure (device is not capable of the operation or device not support + * Bypass) **/ int get_tx_sd(int if_index); @@ -338,8 +358,8 @@ int get_tap_change_sd(int if_index); * @dis_tap: disable tap(1=dis, 0=en) * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support TAP - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * TAP or it's a slave device) **/ int set_dis_tap_sd(int if_index, int dis_tap); @@ -348,8 +368,8 @@ int set_dis_tap_sd(int if_index, int dis_tap); * @if_index: network device index of the controlling device * Output: * 0/1 - on success (normal TAP mode/ Disable TAP) - * -1 - on failure (device is not capable of the operation ordevice not support TAP - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not support + * TAP or it's a slave device) **/ int get_dis_tap_sd(int if_index); @@ -359,8 +379,8 @@ int get_dis_tap_sd(int if_index); * @bypass_mode: tap mode setting at power up state (1=TAP en, 0=TAP Dis) * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support TAP - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not + * support TAP or it's a slave device) **/ int set_tap_pwup_sd(int if_index, int tap_mode); @@ -369,8 +389,8 @@ int set_tap_pwup_sd(int if_index, int tap_mode); * @if_index: network device index of the controlling device * Output: * 0/1 - on success (Disable TAP at power up state / normal TAP mode) - * -1 - on failure (device is not capable of the operation ordevice not support TAP - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not + * support TAP or it's a slave device) **/ int get_tap_pwup_sd(int if_index); @@ -408,8 +428,8 @@ int get_bp_disc_change_sd(int if_index); * @dis_tap: disable tap(1=dis, 0=en) * Output: * 0 - on success - * -1 - on failure (device is not capable ofthe operation ordevice not support Disconnect - * or it's a slave device) + * -1 - on failure (device is not capable ofthe operation or device not + * support Disconnect or it's a slave device) **/ int set_bp_dis_disc_sd(int if_index, int dis_disc); @@ -418,8 +438,8 @@ int set_bp_dis_disc_sd(int if_index, int dis_disc); * @if_index: network device index of the controlling device * Output: * 0/1 - on success (normal Disconnect mode/ Disable Disconnect) - * -1 - on failure (device is not capable of the operation ordevice not support Disconnect - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not + * support Disconnect or it's a slave device) **/ int get_bp_dis_disc_sd(int if_index); @@ -429,8 +449,8 @@ int get_bp_dis_disc_sd(int if_index); * @disc_mode: tap mode setting at power up state (1=Disc en, 0=Disc Dis) * Output: * 0 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Disconnect - * or it's a slave device) + * -1 - on failure (device is not capable of the operation or device not + * support Disconnect or it's a slave device) **/ int set_bp_disc_pwup_sd(int if_index, int disc_mode); @@ -438,9 +458,10 @@ int set_bp_disc_pwup_sd(int if_index, int disc_mode); * get_bp_disc_pwup - Get Disconnect mode state at power-up state * @if_index: network device index of the controlling device * Output: - * 0/1 - on success (Disable Disconnect at power up state / normal Disconnect mode) - * -1 - on failure (device is not capable of the operation ordevice not support TAP - * or it's a slave device) + * 0/1 - on success (Disable Disconnect at power up state / normal Disconnect + * mode) + * -1 - on failure (device is not capable of the operation or device not + * support TAP or it's a slave device) **/ int get_bp_disc_pwup_sd(int if_index); @@ -469,8 +490,9 @@ int get_wd_exp_mode_sd(int if_index); * @bypass_mode: adapter mode (1=tap mode, 0=bypass mode) * Output: * 1 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device or unknown wdt status) + * -1 - on failure (device is not capable of the operation or device not + * support Bypass or it's a slave device or unknown wdt + * status) **/ int set_wd_autoreset_sd(int if_index, int time); @@ -480,8 +502,9 @@ int set_wd_autoreset_sd(int if_index, int time); * @bypass_mode: adapter mode (1=tap mode, 0=bypass mode) * Output: * 1 - on success - * -1 - on failure (device is not capable of the operation ordevice not support Bypass - * or it's a slave device or unknown wdt status) + * -1 - on failure (device is not capable of the operation or device not + * support Bypass or it's a slave device or unknown wdt + * status) **/ int get_wd_autoreset_sd(int if_index); |