/*******************************************************************************

  Intel 10 Gigabit PCI Express Linux driver
  Copyright(c) 1999 - 2013 Intel Corporation.

  This program is free software; you can redistribute it and/or modify it
  under the terms and conditions of the GNU General Public License,
  version 2, as published by the Free Software Foundation.

  This program is distributed in the hope it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  more details.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.

  The full GNU General Public License is included in this distribution in
  the file called "COPYING".

  Contact Information:
  Linux NICS <linux.nics@intel.com>
  e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497

*******************************************************************************/
#include "ixgbe.h"
#include <linux/ptp_classify.h>

/*
 * The 82599 and the X540 do not have true 64bit nanosecond scale
 * counter registers. Instead, SYSTIME is defined by a fixed point
 * system which allows the user to define the scale counter increment
 * value at every level change of the oscillator driving the SYSTIME
 * value. For both devices the TIMINCA:IV field defines this
 * increment. On the X540 device, 31 bits are provided. However on the
 * 82599 only provides 24 bits. The time unit is determined by the
 * clock frequency of the oscillator in combination with the TIMINCA
 * register. When these devices link at 10Gb the oscillator has a
 * period of 6.4ns. In order to convert the scale counter into
 * nanoseconds the cyclecounter and timecounter structures are
 * used. The SYSTIME registers need to be converted to ns values by use
 * of only a right shift (division by power of 2). The following math
 * determines the largest incvalue that will fit into the available
 * bits in the TIMINCA register.
 *
 * PeriodWidth: Number of bits to store the clock period
 * MaxWidth: The maximum width value of the TIMINCA register
 * Period: The clock period for the oscillator
 * round(): discard the fractional portion of the calculation
 *
 * Period * [ 2 ^ ( MaxWidth - PeriodWidth ) ]
 *
 * For the X540, MaxWidth is 31 bits, and the base period is 6.4 ns
 * For the 82599, MaxWidth is 24 bits, and the base period is 6.4 ns
 *
 * The period also changes based on the link speed:
 * At 10Gb link or no link, the period remains the same.
 * At 1Gb link, the period is multiplied by 10. (64ns)
 * At 100Mb link, the period is multiplied by 100. (640ns)
 *
 * The calculated value allows us to right shift the SYSTIME register
 * value in order to quickly convert it into a nanosecond clock,
 * while allowing for the maximum possible adjustment value.
 *
 * These diagrams are only for the 10Gb link period
 *
 *           SYSTIMEH            SYSTIMEL
 *       +--------------+  +--------------+
 * X540  |      32      |  | 1 | 3 |  28  |
 *       *--------------+  +--------------+
 *        \________ 36 bits ______/  fract
 *
 *       +--------------+  +--------------+
 * 82599 |      32      |  | 8 | 3 |  21  |
 *       *--------------+  +--------------+
 *        \________ 43 bits ______/  fract
 *
 * The 36 bit X540 SYSTIME overflows every
 *   2^36 * 10^-9 / 60 = 1.14 minutes or 69 seconds
 *
 * The 43 bit 82599 SYSTIME overflows every
 *   2^43 * 10^-9 / 3600 = 2.4 hours
 */
#define IXGBE_INCVAL_10GB 0x66666666
#define IXGBE_INCVAL_1GB  0x40000000
#define IXGBE_INCVAL_100  0x50000000

#define IXGBE_INCVAL_SHIFT_10GB  28
#define IXGBE_INCVAL_SHIFT_1GB   24
#define IXGBE_INCVAL_SHIFT_100   21

#define IXGBE_INCVAL_SHIFT_82599 7
#define IXGBE_INCPER_SHIFT_82599 24
#define IXGBE_MAX_TIMEADJ_VALUE  0x7FFFFFFFFFFFFFFFULL

#define IXGBE_OVERFLOW_PERIOD    (HZ * 30)
#define IXGBE_PTP_TX_TIMEOUT     (HZ * 15)

/* half of a one second clock period, for use with PPS signal. We have to use
 * this instead of something pre-defined like IXGBE_PTP_PPS_HALF_SECOND, in
 * order to force at least 64bits of precision for shifting
 */
#define IXGBE_PTP_PPS_HALF_SECOND 500000000ULL

/**
 * ixgbe_ptp_setup_sdp
 * @hw: the hardware private structure
 *
 * this function enables or disables the clock out feature on SDP0 for
 * the X540 device. It will create a 1second periodic output that can
 * be used as the PPS (via an interrupt).
 *
 * It calculates when the systime will be on an exact second, and then
 * aligns the start of the PPS signal to that value. The shift is
 * necessary because it can change based on the link speed.
 */
static void ixgbe_ptp_setup_sdp(struct ixgbe_adapter *adapter)
{
        struct ixgbe_hw *hw = &adapter->hw;
        int shift = adapter->cc.shift;
        u32 esdp, tsauxc, clktiml, clktimh, trgttiml, trgttimh, rem;
        u64 ns = 0, clock_edge = 0;

        if ((adapter->flags2 & IXGBE_FLAG2_PTP_PPS_ENABLED) &&
            (hw->mac.type == ixgbe_mac_X540)) {

                /* disable the pin first */
                IXGBE_WRITE_REG(hw, IXGBE_TSAUXC, 0x0);
                IXGBE_WRITE_FLUSH(hw);

                esdp = IXGBE_READ_REG(hw, IXGBE_ESDP);

                /*
                 * enable the SDP0 pin as output, and connected to the
                 * native function for Timesync (ClockOut)
                 */
                esdp |= (IXGBE_ESDP_SDP0_DIR |
                         IXGBE_ESDP_SDP0_NATIVE);

                /*
                 * enable the Clock Out feature on SDP0, and allow
                 * interrupts to occur when the pin changes
                 */
                tsauxc = (IXGBE_TSAUXC_EN_CLK |
                          IXGBE_TSAUXC_SYNCLK |
                          IXGBE_TSAUXC_SDP0_INT);

                /* clock period (or pulse length) */
                clktiml = (u32)(IXGBE_PTP_PPS_HALF_SECOND << shift);
                clktimh = (u32)((IXGBE_PTP_PPS_HALF_SECOND << shift) >> 32);

                /*
                 * Account for the cyclecounter wrap-around value by
                 * using the converted ns value of the current time to
                 * check for when the next aligned second would occur.
                 */
                clock_edge |= (u64)IXGBE_READ_REG(hw, IXGBE_SYSTIML);
                clock_edge |= (u64)IXGBE_READ_REG(hw, IXGBE_SYSTIMH) << 32;
                ns = timecounter_cyc2time(&adapter->tc, clock_edge);

                div_u64_rem(ns, IXGBE_PTP_PPS_HALF_SECOND, &rem);
                clock_edge += ((IXGBE_PTP_PPS_HALF_SECOND - (u64)rem) << shift);

                /* specify the initial clock start time */
                trgttiml = (u32)clock_edge;
                trgttimh = (u32)(clock_edge >> 32);

                IXGBE_WRITE_REG(hw, IXGBE_CLKTIML, clktiml);
                IXGBE_WRITE_REG(hw, IXGBE_CLKTIMH, clktimh);
                IXGBE_WRITE_REG(hw, IXGBE_TRGTTIML0, trgttiml);
                IXGBE_WRITE_REG(hw, IXGBE_TRGTTIMH0, trgttimh);

                IXGBE_WRITE_REG(hw, IXGBE_ESDP, esdp);
                IXGBE_WRITE_REG(hw, IXGBE_TSAUXC, tsauxc);
        } else {
                IXGBE_WRITE_REG(hw, IXGBE_TSAUXC, 0x0);
        }

        IXGBE_WRITE_FLUSH(hw);
}

/**
 * ixgbe_ptp_read - read raw cycle counter (to be used by time counter)
 * @cc: the cyclecounter structure
 *
 * this function reads the cyclecounter registers and is called by the
 * cyclecounter structure used to construct a ns counter from the
 * arbitrary fixed point registers
 */
static cycle_t ixgbe_ptp_read(const struct cyclecounter *cc)
{
        struct ixgbe_adapter *adapter =
                container_of(cc, struct ixgbe_adapter, cc);
        struct ixgbe_hw *hw = &adapter->hw;
        u64 stamp = 0;

        stamp |= (u64)IXGBE_READ_REG(hw, IXGBE_SYSTIML);
        stamp |= (u64)IXGBE_READ_REG(hw, IXGBE_SYSTIMH) << 32;

        return stamp;
}

/**
 * ixgbe_ptp_adjfreq
 * @ptp: the ptp clock structure
 * @ppb: parts per billion adjustment from base
 *
 * adjust the frequency of the ptp cycle counter by the
 * indicated ppb from the base frequency.
 */
static int ixgbe_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb)
{
        struct ixgbe_adapter *adapter =
                container_of(ptp, struct ixgbe_adapter, ptp_caps);
        struct ixgbe_hw *hw = &adapter->hw;
        u64 freq;
        u32 diff, incval;
        int neg_adj = 0;

        if (ppb < 0) {
                neg_adj = 1;
                ppb = -ppb;
        }

        smp_mb();
        incval = ACCESS_ONCE(adapter->base_incval);

        freq = incval;
        freq *= ppb;
        diff = div_u64(freq, 1000000000ULL);

        incval = neg_adj ? (incval - diff) : (incval + diff);

        switch (hw->mac.type) {
        case ixgbe_mac_X540:
                IXGBE_WRITE_REG(hw, IXGBE_TIMINCA, incval);
                break;
        case ixgbe_mac_82599EB:
                IXGBE_WRITE_REG(hw, IXGBE_TIMINCA,
                                (1 << IXGBE_INCPER_SHIFT_82599) |
                                incval);
                break;
        default:
                break;
        }

        return 0;
}

/**
 * ixgbe_ptp_adjtime
 * @ptp: the ptp clock structure
 * @delta: offset to adjust the cycle counter by
 *
 * adjust the timer by resetting the timecounter structure.
 */
static int ixgbe_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta)
{
        struct ixgbe_adapter *adapter =
                container_of(ptp, struct ixgbe_adapter, ptp_caps);
        unsigned long flags;

        spin_lock_irqsave(&adapter->tmreg_lock, flags);
        timecounter_adjtime(&adapter->tc, delta);
        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);

        ixgbe_ptp_setup_sdp(adapter);

        return 0;
}

/**
 * ixgbe_ptp_gettime
 * @ptp: the ptp clock structure
 * @ts: timespec structure to hold the current time value
 *
 * read the timecounter and return the correct value on ns,
 * after converting it into a struct timespec.
 */
static int ixgbe_ptp_gettime(struct ptp_clock_info *ptp, struct timespec64 *ts)
{
        struct ixgbe_adapter *adapter =
                container_of(ptp, struct ixgbe_adapter, ptp_caps);
        u64 ns;
        unsigned long flags;

        spin_lock_irqsave(&adapter->tmreg_lock, flags);
        ns = timecounter_read(&adapter->tc);
        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);

        *ts = ns_to_timespec64(ns);

        return 0;
}

/**
 * ixgbe_ptp_settime
 * @ptp: the ptp clock structure
 * @ts: the timespec containing the new time for the cycle counter
 *
 * reset the timecounter to use a new base value instead of the kernel
 * wall timer value.
 */
static int ixgbe_ptp_settime(struct ptp_clock_info *ptp,
                             const struct timespec64 *ts)
{
        struct ixgbe_adapter *adapter =
                container_of(ptp, struct ixgbe_adapter, ptp_caps);
        u64 ns;
        unsigned long flags;

        ns = timespec64_to_ns(ts);

        /* reset the timecounter */
        spin_lock_irqsave(&adapter->tmreg_lock, flags);
        timecounter_init(&adapter->tc, &adapter->cc, ns);
        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);

        ixgbe_ptp_setup_sdp(adapter);
        return 0;
}

/**
 * ixgbe_ptp_feature_enable
 * @ptp: the ptp clock structure
 * @rq: the requested feature to change
 * @on: whether to enable or disable the feature
 *
 * enable (or disable) ancillary features of the phc subsystem.
 * our driver only supports the PPS feature on the X540
 */
static int ixgbe_ptp_feature_enable(struct ptp_clock_info *ptp,
                                    struct ptp_clock_request *rq, int on)
{
        struct ixgbe_adapter *adapter =
                container_of(ptp, struct ixgbe_adapter, ptp_caps);

        /**
         * When PPS is enabled, unmask the interrupt for the ClockOut
         * feature, so that the interrupt handler can send the PPS
         * event when the clock SDP triggers. Clear mask when PPS is
         * disabled
         */
        if (rq->type == PTP_CLK_REQ_PPS) {
                switch (adapter->hw.mac.type) {
                case ixgbe_mac_X540:
                        if (on)
                                adapter->flags2 |= IXGBE_FLAG2_PTP_PPS_ENABLED;
                        else
                                adapter->flags2 &= ~IXGBE_FLAG2_PTP_PPS_ENABLED;

                        ixgbe_ptp_setup_sdp(adapter);
                        return 0;
                default:
                        break;
                }
        }

        return -ENOTSUPP;
}

/**
 * ixgbe_ptp_check_pps_event
 * @adapter: the private adapter structure
 * @eicr: the interrupt cause register value
 *
 * This function is called by the interrupt routine when checking for
 * interrupts. It will check and handle a pps event.
 */
void ixgbe_ptp_check_pps_event(struct ixgbe_adapter *adapter, u32 eicr)
{
        struct ixgbe_hw *hw = &adapter->hw;
        struct ptp_clock_event event;

        event.type = PTP_CLOCK_PPS;

        /* this check is necessary in case the interrupt was enabled via some
         * alternative means (ex. debug_fs). Better to check here than
         * everywhere that calls this function.
         */
        if (!adapter->ptp_clock)
                return;

        switch (hw->mac.type) {
        case ixgbe_mac_X540:
                ptp_clock_event(adapter->ptp_clock, &event);
                break;
        default:
                break;
        }
}

/**
 * ixgbe_ptp_overflow_check - watchdog task to detect SYSTIME overflow
 * @adapter: private adapter struct
 *
 * this watchdog task periodically reads the timecounter
 * in order to prevent missing when the system time registers wrap
 * around. This needs to be run approximately twice a minute.
 */
void ixgbe_ptp_overflow_check(struct ixgbe_adapter *adapter)
{
        bool timeout = time_is_before_jiffies(adapter->last_overflow_check +
                                             IXGBE_OVERFLOW_PERIOD);
        struct timespec64 ts;

        if (timeout) {
                ixgbe_ptp_gettime(&adapter->ptp_caps, &ts);
                adapter->last_overflow_check = jiffies;
        }
}

/**
 * ixgbe_ptp_rx_hang - detect error case when Rx timestamp registers latched
 * @adapter: private network adapter structure
 *
 * this watchdog task is scheduled to detect error case where hardware has
 * dropped an Rx packet that was timestamped when the ring is full. The
 * particular error is rare but leaves the device in a state unable to timestamp
 * any future packets.
 */
void ixgbe_ptp_rx_hang(struct ixgbe_adapter *adapter)
{
        struct ixgbe_hw *hw = &adapter->hw;
        u32 tsyncrxctl = IXGBE_READ_REG(hw, IXGBE_TSYNCRXCTL);
        unsigned long rx_event;

        /* if we don't have a valid timestamp in the registers, just update the
         * timeout counter and exit
         */
        if (!(tsyncrxctl & IXGBE_TSYNCRXCTL_VALID)) {
                adapter->last_rx_ptp_check = jiffies;
                return;
        }

        /* determine the most recent watchdog or rx_timestamp event */
        rx_event = adapter->last_rx_ptp_check;
        if (time_after(adapter->last_rx_timestamp, rx_event))
                rx_event = adapter->last_rx_timestamp;

        /* only need to read the high RXSTMP register to clear the lock */
        if (time_is_before_jiffies(rx_event + 5*HZ)) {
                IXGBE_READ_REG(hw, IXGBE_RXSTMPH);
                adapter->last_rx_ptp_check = jiffies;

                e_warn(drv, "clearing RX Timestamp hang\n");
        }
}

/**
 * ixgbe_ptp_tx_hwtstamp - utility function which checks for TX time stamp
 * @adapter: the private adapter struct
 *
 * if the timestamp is valid, we convert it into the timecounter ns
 * value, then store that result into the shhwtstamps structure which
 * is passed up the network stack
 */
static void ixgbe_ptp_tx_hwtstamp(struct ixgbe_adapter *adapter)
{
        struct ixgbe_hw *hw = &adapter->hw;
        struct skb_shared_hwtstamps shhwtstamps;
        u64 regval = 0, ns;
        unsigned long flags;

        regval |= (u64)IXGBE_READ_REG(hw, IXGBE_TXSTMPL);
        regval |= (u64)IXGBE_READ_REG(hw, IXGBE_TXSTMPH) << 32;

        spin_lock_irqsave(&adapter->tmreg_lock, flags);
        ns = timecounter_cyc2time(&adapter->tc, regval);
        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);

        memset(&shhwtstamps, 0, sizeof(shhwtstamps));
        shhwtstamps.hwtstamp = ns_to_ktime(ns);
        skb_tstamp_tx(adapter->ptp_tx_skb, &shhwtstamps);

        dev_kfree_skb_any(adapter->ptp_tx_skb);
        adapter->ptp_tx_skb = NULL;
        clear_bit_unlock(__IXGBE_PTP_TX_IN_PROGRESS, &adapter->state);
}

/**
 * ixgbe_ptp_tx_hwtstamp_work
 * @work: pointer to the work struct
 *
 * This work item polls TSYNCTXCTL valid bit to determine when a Tx hardware
 * timestamp has been taken for the current skb. It is necessary, because the
 * descriptor's "done" bit does not correlate with the timestamp event.
 */
static void ixgbe_ptp_tx_hwtstamp_work(struct work_struct *work)
{
        struct ixgbe_adapter *adapter = container_of(work, struct ixgbe_adapter,
                                                     ptp_tx_work);
        struct ixgbe_hw *hw = &adapter->hw;
        bool timeout = time_is_before_jiffies(adapter->ptp_tx_start +
                                              IXGBE_PTP_TX_TIMEOUT);
        u32 tsynctxctl;

        if (timeout) {
                dev_kfree_skb_any(adapter->ptp_tx_skb);
                adapter->ptp_tx_skb = NULL;
                clear_bit_unlock(__IXGBE_PTP_TX_IN_PROGRESS, &adapter->state);
                e_warn(drv, "clearing Tx Timestamp hang\n");
                return;
        }

        tsynctxctl = IXGBE_READ_REG(hw, IXGBE_TSYNCTXCTL);
        if (tsynctxctl & IXGBE_TSYNCTXCTL_VALID)
                ixgbe_ptp_tx_hwtstamp(adapter);
        else
                /* reschedule to keep checking if it's not available yet */
                schedule_work(&adapter->ptp_tx_work);
}

/**
 * ixgbe_ptp_rx_hwtstamp - utility function which checks for RX time stamp
 * @adapter: pointer to adapter struct
 * @skb: particular skb to send timestamp with
 *
 * if the timestamp is valid, we convert it into the timecounter ns
 * value, then store that result into the shhwtstamps structure which
 * is passed up the network stack
 */
void ixgbe_ptp_rx_hwtstamp(struct ixgbe_adapter *adapter, struct sk_buff *skb)
{
        struct ixgbe_hw *hw = &adapter->hw;
        struct skb_shared_hwtstamps *shhwtstamps;
        u64 regval = 0, ns;
        u32 tsyncrxctl;
        unsigned long flags;

        tsyncrxctl = IXGBE_READ_REG(hw, IXGBE_TSYNCRXCTL);
        if (!(tsyncrxctl & IXGBE_TSYNCRXCTL_VALID))
                return;

        regval |= (u64)IXGBE_READ_REG(hw, IXGBE_RXSTMPL);
        regval |= (u64)IXGBE_READ_REG(hw, IXGBE_RXSTMPH) << 32;

        spin_lock_irqsave(&adapter->tmreg_lock, flags);
        ns = timecounter_cyc2time(&adapter->tc, regval);
        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);

        shhwtstamps = skb_hwtstamps(skb);
        shhwtstamps->hwtstamp = ns_to_ktime(ns);

        /* Update the last_rx_timestamp timer in order to enable watchdog check
         * for error case of latched timestamp on a dropped packet.
         */
        adapter->last_rx_timestamp = jiffies;
}

int ixgbe_ptp_get_ts_config(struct ixgbe_adapter *adapter, struct ifreq *ifr)
{
        struct hwtstamp_config *config = &adapter->tstamp_config;

        return copy_to_user(ifr->ifr_data, config,
                            sizeof(*config)) ? -EFAULT : 0;
}

/**
 * ixgbe_ptp_set_timestamp_mode - setup the hardware for the requested mode
 * @adapter: the private ixgbe adapter structure
 * @config: the hwtstamp configuration requested
 *
 * Outgoing time stamping can be enabled and disabled. Play nice and
 * disable it when requested, although it shouldn't cause any overhead
 * when no packet needs it. At most one packet in the queue may be
 * marked for time stamping, otherwise it would be impossible to tell
 * for sure to which packet the hardware time stamp belongs.
 *
 * Incoming time stamping has to be configured via the hardware
 * filters. Not all combinations are supported, in particular event
 * type has to be specified. Matching the kind of event packet is
 * not supported, with the exception of "all V2 events regardless of
 * level 2 or 4".
 *
 * Since hardware always timestamps Path delay packets when timestamping V2
 * packets, regardless of the type specified in the register, only use V2
 * Event mode. This more accurately tells the user what the hardware is going
 * to do anyways.
 *
 * Note: this may modify the hwtstamp configuration towards a more general
 * mode, if required to support the specifically requested mode.
 */
static int ixgbe_ptp_set_timestamp_mode(struct ixgbe_adapter *adapter,
                                 struct hwtstamp_config *config)
{
        struct ixgbe_hw *hw = &adapter->hw;
        u32 tsync_tx_ctl = IXGBE_TSYNCTXCTL_ENABLED;
        u32 tsync_rx_ctl = IXGBE_TSYNCRXCTL_ENABLED;
        u32 tsync_rx_mtrl = PTP_EV_PORT << 16;
        bool is_l2 = false;
        u32 regval;

        /* reserved for future extensions */
        if (config->flags)
                return -EINVAL;

        switch (config->tx_type) {
        case HWTSTAMP_TX_OFF:
                tsync_tx_ctl = 0;
        case HWTSTAMP_TX_ON:
                break;
        default:
                return -ERANGE;
        }

        switch (config->rx_filter) {
        case HWTSTAMP_FILTER_NONE:
                tsync_rx_ctl = 0;
                tsync_rx_mtrl = 0;
                break;
        case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
                tsync_rx_ctl |= IXGBE_TSYNCRXCTL_TYPE_L4_V1;
                tsync_rx_mtrl |= IXGBE_RXMTRL_V1_SYNC_MSG;
                break;
        case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
                tsync_rx_ctl |= IXGBE_TSYNCRXCTL_TYPE_L4_V1;
                tsync_rx_mtrl |= IXGBE_RXMTRL_V1_DELAY_REQ_MSG;
                break;
        case HWTSTAMP_FILTER_PTP_V2_EVENT:
        case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
        case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
        case HWTSTAMP_FILTER_PTP_V2_SYNC:
        case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
        case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
        case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
        case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
        case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
                tsync_rx_ctl |= IXGBE_TSYNCRXCTL_TYPE_EVENT_V2;
                is_l2 = true;
                config->rx_filter = HWTSTAMP_FILTER_PTP_V2_EVENT;
                break;
        case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
        case HWTSTAMP_FILTER_ALL:
        default:
                /*
                 * register RXMTRL must be set in order to do V1 packets,
                 * therefore it is not possible to time stamp both V1 Sync and
                 * Delay_Req messages and hardware does not support
                 * timestamping all packets => return error
                 */
                config->rx_filter = HWTSTAMP_FILTER_NONE;
                return -ERANGE;
        }

        if (hw->mac.type == ixgbe_mac_82598EB) {
                if (tsync_rx_ctl | tsync_tx_ctl)
                        return -ERANGE;
                return 0;
        }

        /* define ethertype filter for timestamping L2 packets */
        if (is_l2)
                IXGBE_WRITE_REG(hw, IXGBE_ETQF(IXGBE_ETQF_FILTER_1588),
                                (IXGBE_ETQF_FILTER_EN | /* enable filter */
                                 IXGBE_ETQF_1588 | /* enable timestamping */
                                 ETH_P_1588));     /* 1588 eth protocol type */
        else
                IXGBE_WRITE_REG(hw, IXGBE_ETQF(IXGBE_ETQF_FILTER_1588), 0);

        /* enable/disable TX */
        regval = IXGBE_READ_REG(hw, IXGBE_TSYNCTXCTL);
        regval &= ~IXGBE_TSYNCTXCTL_ENABLED;
        regval |= tsync_tx_ctl;
        IXGBE_WRITE_REG(hw, IXGBE_TSYNCTXCTL, regval);

        /* enable/disable RX */
        regval = IXGBE_READ_REG(hw, IXGBE_TSYNCRXCTL);
        regval &= ~(IXGBE_TSYNCRXCTL_ENABLED | IXGBE_TSYNCRXCTL_TYPE_MASK);
        regval |= tsync_rx_ctl;
        IXGBE_WRITE_REG(hw, IXGBE_TSYNCRXCTL, regval);

        /* define which PTP packets are time stamped */
        IXGBE_WRITE_REG(hw, IXGBE_RXMTRL, tsync_rx_mtrl);

        IXGBE_WRITE_FLUSH(hw);

        /* clear TX/RX time stamp registers, just to be sure */
        regval = IXGBE_READ_REG(hw, IXGBE_TXSTMPH);
        regval = IXGBE_READ_REG(hw, IXGBE_RXSTMPH);

        return 0;
}

/**
 * ixgbe_ptp_set_ts_config - user entry point for timestamp mode
 * @adapter: pointer to adapter struct
 * @ifreq: ioctl data
 *
 * Set hardware to requested mode. If unsupported, return an error with no
 * changes. Otherwise, store the mode for future reference.
 */
int ixgbe_ptp_set_ts_config(struct ixgbe_adapter *adapter, struct ifreq *ifr)
{
        struct hwtstamp_config config;
        int err;

        if (copy_from_user(&config, ifr->ifr_data, sizeof(config)))
                return -EFAULT;

        err = ixgbe_ptp_set_timestamp_mode(adapter, &config);
        if (err)
                return err;

        /* save these settings for future reference */
        memcpy(&adapter->tstamp_config, &config,
               sizeof(adapter->tstamp_config));

        return copy_to_user(ifr->ifr_data, &config, sizeof(config)) ?
                -EFAULT : 0;
}

/**
 * ixgbe_ptp_start_cyclecounter - create the cycle counter from hw
 * @adapter: pointer to the adapter structure
 *
 * This function should be called to set the proper values for the TIMINCA
 * register and tell the cyclecounter structure what the tick rate of SYSTIME
 * is. It does not directly modify SYSTIME registers or the timecounter
 * structure. It should be called whenever a new TIMINCA value is necessary,
 * such as during initialization or when the link speed changes.
 */
void ixgbe_ptp_start_cyclecounter(struct ixgbe_adapter *adapter)
{
        struct ixgbe_hw *hw = &adapter->hw;
        u32 incval = 0;
        u32 shift = 0;
        unsigned long flags;

        /**
         * Scale the NIC cycle counter by a large factor so that
         * relatively small corrections to the frequency can be added
         * or subtracted. The drawbacks of a large factor include
         * (a) the clock register overflows more quickly, (b) the cycle
         * counter structure must be able to convert the systime value
         * to nanoseconds using only a multiplier and a right-shift,
         * and (c) the value must fit within the timinca register space
         * => math based on internal DMA clock rate and available bits
         *
         * Note that when there is no link, internal DMA clock is same as when
         * link speed is 10Gb. Set the registers correctly even when link is
         * down to preserve the clock setting
         */
        switch (adapter->link_speed) {
        case IXGBE_LINK_SPEED_100_FULL:
                incval = IXGBE_INCVAL_100;
                shift = IXGBE_INCVAL_SHIFT_100;
                break;
        case IXGBE_LINK_SPEED_1GB_FULL:
                incval = IXGBE_INCVAL_1GB;
                shift = IXGBE_INCVAL_SHIFT_1GB;
                break;
        case IXGBE_LINK_SPEED_10GB_FULL:
        default:
                incval = IXGBE_INCVAL_10GB;
                shift = IXGBE_INCVAL_SHIFT_10GB;
                break;
        }

        /**
         * Modify the calculated values to fit within the correct
         * number of bits specified by the hardware. The 82599 doesn't
         * have the same space as the X540, so bitshift the calculated
         * values to fit.
         */
        switch (hw->mac.type) {
        case ixgbe_mac_X540:
                IXGBE_WRITE_REG(hw, IXGBE_TIMINCA, incval);
                break;
        case ixgbe_mac_82599EB:
                incval >>= IXGBE_INCVAL_SHIFT_82599;
                shift -= IXGBE_INCVAL_SHIFT_82599;
                IXGBE_WRITE_REG(hw, IXGBE_TIMINCA,
                                (1 << IXGBE_INCPER_SHIFT_82599) |
                                incval);
                break;
        default:
                /* other devices aren't supported */
                return;
        }

        /* update the base incval used to calculate frequency adjustment */
        ACCESS_ONCE(adapter->base_incval) = incval;
        smp_mb();

        /* need lock to prevent incorrect read while modifying cyclecounter */
        spin_lock_irqsave(&adapter->tmreg_lock, flags);

        memset(&adapter->cc, 0, sizeof(adapter->cc));
        adapter->cc.read = ixgbe_ptp_read;
        adapter->cc.mask = CYCLECOUNTER_MASK(64);
        adapter->cc.shift = shift;
        adapter->cc.mult = 1;

        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);
}

/**
 * ixgbe_ptp_reset
 * @adapter: the ixgbe private board structure
 *
 * When the MAC resets, all the hardware bits for timesync are reset. This
 * function is used to re-enable the device for PTP based on current settings.
 * We do lose the current clock time, so just reset the cyclecounter to the
 * system real clock time.
 *
 * This function will maintain hwtstamp_config settings, and resets the SDP
 * output if it was enabled.
 */
void ixgbe_ptp_reset(struct ixgbe_adapter *adapter)
{
        struct ixgbe_hw *hw = &adapter->hw;
        unsigned long flags;

        /* set SYSTIME registers to 0 just in case */
        IXGBE_WRITE_REG(hw, IXGBE_SYSTIML, 0x00000000);
        IXGBE_WRITE_REG(hw, IXGBE_SYSTIMH, 0x00000000);
        IXGBE_WRITE_FLUSH(hw);

        /* reset the hardware timestamping mode */
        ixgbe_ptp_set_timestamp_mode(adapter, &adapter->tstamp_config);

        ixgbe_ptp_start_cyclecounter(adapter);

        spin_lock_irqsave(&adapter->tmreg_lock, flags);

        /* reset the ns time counter */
        timecounter_init(&adapter->tc, &adapter->cc,
                         ktime_to_ns(ktime_get_real()));

        spin_unlock_irqrestore(&adapter->tmreg_lock, flags);

        /*
         * Now that the shift has been calculated and the systime
         * registers reset, (re-)enable the Clock out feature
         */
        ixgbe_ptp_setup_sdp(adapter);
}

/**
 * ixgbe_ptp_create_clock
 * @adapter: the ixgbe private adapter structure
 *
 * This function performs setup of the user entry point function table and
 * initializes the PTP clock device, which is used to access the clock-like
 * features of the PTP core. It will be called by ixgbe_ptp_init, only if
 * there isn't already a clock device (such as after a suspend/resume cycle,
 * where the clock device wasn't destroyed).
 */
static int ixgbe_ptp_create_clock(struct ixgbe_adapter *adapter)
{
        struct net_device *netdev = adapter->netdev;
        long err;

        /* do nothing if we already have a clock device */
        if (!IS_ERR_OR_NULL(adapter->ptp_clock))
                return 0;

        switch (adapter->hw.mac.type) {
        case ixgbe_mac_X540:
                snprintf(adapter->ptp_caps.name,
                         sizeof(adapter->ptp_caps.name),
                         "%s", netdev->name);
                adapter->ptp_caps.owner = THIS_MODULE;
                adapter->ptp_caps.max_adj = 250000000;
                adapter->ptp_caps.n_alarm = 0;
                adapter->ptp_caps.n_ext_ts = 0;
                adapter->ptp_caps.n_per_out = 0;
                adapter->ptp_caps.pps = 1;
                adapter->ptp_caps.adjfreq = ixgbe_ptp_adjfreq;
                adapter->ptp_caps.adjtime = ixgbe_ptp_adjtime;
                adapter->ptp_caps.gettime64 = ixgbe_ptp_gettime;
                adapter->ptp_caps.settime64 = ixgbe_ptp_settime;
                adapter->ptp_caps.enable = ixgbe_ptp_feature_enable;
                break;
        case ixgbe_mac_82599EB:
                snprintf(adapter->ptp_caps.name,
                         sizeof(adapter->ptp_caps.name),
                         "%s", netdev->name);
                adapter->ptp_caps.owner = THIS_MODULE;
                adapter->ptp_caps.max_adj = 250000000;
                adapter->ptp_caps.n_alarm = 0;
                adapter->ptp_caps.n_ext_ts = 0;
                adapter->ptp_caps.n_per_out = 0;
                adapter->ptp_caps.pps = 0;
                adapter->ptp_caps.adjfreq = ixgbe_ptp_adjfreq;
                adapter->ptp_caps.adjtime = ixgbe_ptp_adjtime;
                adapter->ptp_caps.gettime64 = ixgbe_ptp_gettime;
                adapter->ptp_caps.settime64 = ixgbe_ptp_settime;
                adapter->ptp_caps.enable = ixgbe_ptp_feature_enable;
                break;
        default:
                adapter->ptp_clock = NULL;
                return -EOPNOTSUPP;
        }

        adapter->ptp_clock = ptp_clock_register(&adapter->ptp_caps,
                                                &adapter->pdev->dev);
        if (IS_ERR(adapter->ptp_clock)) {
                err = PTR_ERR(adapter->ptp_clock);
                adapter->ptp_clock = NULL;
                e_dev_err("ptp_clock_register failed\n");
                return err;
        } else
                e_dev_info("registered PHC device on %s\n", netdev->name);

        /* set default timestamp mode to disabled here. We do this in
         * create_clock instead of init, because we don't want to override the
         * previous settings during a resume cycle.
         */
        adapter->tstamp_config.rx_filter = HWTSTAMP_FILTER_NONE;
        adapter->tstamp_config.tx_type = HWTSTAMP_TX_OFF;

        return 0;
}

/**
 * ixgbe_ptp_init
 * @adapter: the ixgbe private adapter structure
 *
 * This function performs the required steps for enabling PTP
 * support. If PTP support has already been loaded it simply calls the
 * cyclecounter init routine and exits.
 */
void ixgbe_ptp_init(struct ixgbe_adapter *adapter)
{
        /* initialize the spin lock first since we can't control when a user
         * will call the entry functions once we have initialized the clock
         * device
         */
        spin_lock_init(&adapter->tmreg_lock);

        /* obtain a PTP device, or re-use an existing device */
        if (ixgbe_ptp_create_clock(adapter))
                return;

        /* we have a clock so we can initialize work now */
        INIT_WORK(&adapter->ptp_tx_work, ixgbe_ptp_tx_hwtstamp_work);

        /* reset the PTP related hardware bits */
        ixgbe_ptp_reset(adapter);

        /* enter the IXGBE_PTP_RUNNING state */
        set_bit(__IXGBE_PTP_RUNNING, &adapter->state);

        return;
}

/**
 * ixgbe_ptp_suspend - stop PTP work items
 * @ adapter: pointer to adapter struct
 *
 * this function suspends PTP activity, and prevents more PTP work from being
 * generated, but does not destroy the PTP clock device.
 */
void ixgbe_ptp_suspend(struct ixgbe_adapter *adapter)
{
        /* Leave the IXGBE_PTP_RUNNING state. */
        if (!test_and_clear_bit(__IXGBE_PTP_RUNNING, &adapter->state))
                return;

        /* since this might be called in suspend, we don't clear the state,
         * but simply reset the auxiliary PPS signal control register
         */
        IXGBE_WRITE_REG(&adapter->hw, IXGBE_TSAUXC, 0x0);

        /* ensure that we cancel any pending PTP Tx work item in progress */
        cancel_work_sync(&adapter->ptp_tx_work);
        if (adapter->ptp_tx_skb) {
                dev_kfree_skb_any(adapter->ptp_tx_skb);
                adapter->ptp_tx_skb = NULL;
                clear_bit_unlock(__IXGBE_PTP_TX_IN_PROGRESS, &adapter->state);
        }
}

/**
 * ixgbe_ptp_stop - close the PTP device
 * @adapter: pointer to adapter struct
 *
 * completely destroy the PTP device, should only be called when the device is
 * being fully closed.
 */
void ixgbe_ptp_stop(struct ixgbe_adapter *adapter)
{
        /* first, suspend PTP activity */
        ixgbe_ptp_suspend(adapter);

        /* disable the PTP clock device */
        if (adapter->ptp_clock) {
                ptp_clock_unregister(adapter->ptp_clock);
                adapter->ptp_clock = NULL;
                e_dev_info("removed PHC on %s\n",
                           adapter->netdev->name);
        }
}