/* SPDX-License-Identifier: GPL-2.0+ */
/* Copyright (C) 2018 Microchip Technology Inc. */

#ifndef _LAN743X_PTP_H
#define _LAN743X_PTP_H

#include "linux/ptp_clock_kernel.h"
#include "linux/netdevice.h"

#define LAN7430_N_LED   4
#define LAN7430_N_GPIO   4 /* multiplexed with PHY LEDs */
#define LAN7431_N_GPIO   12

#define LAN743X_PTP_N_GPIO  LAN7431_N_GPIO

/* the number of periodic outputs is limited by number of
 * PTP clock event channels
 */
#define LAN743X_PTP_N_EVENT_CHAN 2
#define LAN743X_PTP_N_PEROUT  LAN743X_PTP_N_EVENT_CHAN
#define PCI11X1X_PTP_IO_MAX_CHANNELS 8
#define LAN743X_PTP_N_EXTTS  PCI11X1X_PTP_IO_MAX_CHANNELS
#define LAN743X_PTP_N_PPS  0
#define PTP_CMD_CTL_TIMEOUT_CNT  50

struct lan743x_adapter;

/* GPIO */
struct lan743x_gpio {
 /* gpio_lock: used to prevent concurrent access to gpio settings */
 spinlock_t gpio_lock;

 int used_bits;
 int output_bits;
 int ptp_bits;
 u32 gpio_cfg0;
 u32 gpio_cfg1;
 u32 gpio_cfg2;
 u32 gpio_cfg3;
};

int lan743x_gpio_init(struct lan743x_adapter *adapter);

void lan743x_ptp_isr(void *context);
bool lan743x_ptp_request_tx_timestamp(struct lan743x_adapter *adapter);
void lan743x_ptp_unrequest_tx_timestamp(struct lan743x_adapter *adapter);
void lan743x_ptp_tx_timestamp_skb(struct lan743x_adapter *adapter,
      struct sk_buff *skb, bool ignore_sync);
int lan743x_ptp_init(struct lan743x_adapter *adapter);
int lan743x_ptp_open(struct lan743x_adapter *adapter);
void lan743x_ptp_close(struct lan743x_adapter *adapter);
void lan743x_ptp_update_latency(struct lan743x_adapter *adapter,
    u32 link_speed);
int lan743x_ptp_hwtstamp_get(struct net_device *netdev,
        struct kernel_hwtstamp_config *config);
int lan743x_ptp_hwtstamp_set(struct net_device *netdev,
        struct kernel_hwtstamp_config *config,
        struct netlink_ext_ack *extack);

#define LAN743X_PTP_NUMBER_OF_TX_TIMESTAMPS (4)

#define PTP_FLAG_PTP_CLOCK_REGISTERED  BIT(1)
#define PTP_FLAG_ISR_ENABLED   BIT(2)

struct lan743x_ptp_perout {
 int  event_ch; /* PTP event channel (0=channel A, 1=channel B) */
 int  gpio_pin; /* GPIO pin where output appears */
};

struct lan743x_extts {
 int flags;
 struct timespec64 ts;
};

struct lan743x_ptp {
 int flags;

 /* command_lock: used to prevent concurrent ptp commands */
 struct mutex command_lock;

 struct ptp_clock *ptp_clock;
 struct ptp_clock_info ptp_clock_info;
 struct ptp_pin_desc pin_config[LAN743X_PTP_N_GPIO];

 unsigned long used_event_ch;
 struct lan743x_ptp_perout perout[LAN743X_PTP_N_PEROUT];
 int ptp_io_perout[LAN743X_PTP_N_PEROUT]; /* PTP event channel (0=channel A, 1=channel B) */
 struct lan743x_extts extts[LAN743X_PTP_N_EXTTS];

 bool leds_multiplexed;
 bool led_enabled[LAN7430_N_LED];

 /* tx_ts_lock: used to prevent concurrent access to timestamp arrays */
 spinlock_t tx_ts_lock;
 int pending_tx_timestamps;
 struct sk_buff *tx_ts_skb_queue[LAN743X_PTP_NUMBER_OF_TX_TIMESTAMPS];
 unsigned int tx_ts_ignore_sync_queue;
 int tx_ts_skb_queue_size;
 u32 tx_ts_seconds_queue[LAN743X_PTP_NUMBER_OF_TX_TIMESTAMPS];
 u32 tx_ts_nseconds_queue[LAN743X_PTP_NUMBER_OF_TX_TIMESTAMPS];
 u32 tx_ts_header_queue[LAN743X_PTP_NUMBER_OF_TX_TIMESTAMPS];
 int tx_ts_queue_size;
};

#endif /* _LAN743X_PTP_H */