1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun ################################################################################ 4*4882a593Smuzhiyun # 5*4882a593Smuzhiyun # r8168 is the Linux device driver released for Realtek Gigabit Ethernet 6*4882a593Smuzhiyun # controllers with PCI-Express interface. 7*4882a593Smuzhiyun # 8*4882a593Smuzhiyun # Copyright(c) 2021 Realtek Semiconductor Corp. All rights reserved. 9*4882a593Smuzhiyun # 10*4882a593Smuzhiyun # This program is free software; you can redistribute it and/or modify it 11*4882a593Smuzhiyun # under the terms of the GNU General Public License as published by the Free 12*4882a593Smuzhiyun # Software Foundation; either version 2 of the License, or (at your option) 13*4882a593Smuzhiyun # any later version. 14*4882a593Smuzhiyun # 15*4882a593Smuzhiyun # This program is distributed in the hope that it will be useful, but WITHOUT 16*4882a593Smuzhiyun # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 17*4882a593Smuzhiyun # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 18*4882a593Smuzhiyun # more details. 19*4882a593Smuzhiyun # 20*4882a593Smuzhiyun # You should have received a copy of the GNU General Public License along with 21*4882a593Smuzhiyun # this program; if not, see <http://www.gnu.org/licenses/>. 22*4882a593Smuzhiyun # 23*4882a593Smuzhiyun # Author: 24*4882a593Smuzhiyun # Realtek NIC software team <nicfae@realtek.com> 25*4882a593Smuzhiyun # No. 2, Innovation Road II, Hsinchu Science Park, Hsinchu 300, Taiwan 26*4882a593Smuzhiyun # 27*4882a593Smuzhiyun ################################################################################ 28*4882a593Smuzhiyun */ 29*4882a593Smuzhiyun 30*4882a593Smuzhiyun /************************************************************************************ 31*4882a593Smuzhiyun * This product is covered by one or more of the following patents: 32*4882a593Smuzhiyun * US6,570,884, US6,115,776, and US6,327,625. 33*4882a593Smuzhiyun ***********************************************************************************/ 34*4882a593Smuzhiyun 35*4882a593Smuzhiyun #ifndef _LINUX_R8168_REALWOW_H 36*4882a593Smuzhiyun #define _LINUX_R8168_REALWOW_H 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun #define SIOCDEVPRIVATE_RTLREALWOW SIOCDEVPRIVATE+3 39*4882a593Smuzhiyun 40*4882a593Smuzhiyun #define MAX_RealWoW_KCP_SIZE (100) 41*4882a593Smuzhiyun #define MAX_RealWoW_Payload (64) 42*4882a593Smuzhiyun 43*4882a593Smuzhiyun #define KA_TX_PACKET_SIZE (100) 44*4882a593Smuzhiyun #define KA_WAKEUP_PATTERN_SIZE (120) 45*4882a593Smuzhiyun 46*4882a593Smuzhiyun //HwSuppKeepAliveOffloadVer 47*4882a593Smuzhiyun #define HW_SUPPORT_KCP_OFFLOAD(_M) ((_M)->HwSuppKCPOffloadVer > 0) 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun enum rtl_realwow_cmd { 50*4882a593Smuzhiyun 51*4882a593Smuzhiyun RTL_REALWOW_SET_KCP_DISABLE=0, 52*4882a593Smuzhiyun RTL_REALWOW_SET_KCP_INFO, 53*4882a593Smuzhiyun RTL_REALWOW_SET_KCP_CONTENT, 54*4882a593Smuzhiyun 55*4882a593Smuzhiyun RTL_REALWOW_SET_KCP_ACKPKTINFO, 56*4882a593Smuzhiyun RTL_REALWOW_SET_KCP_WPINFO, 57*4882a593Smuzhiyun RTL_REALWOW_SET_KCPDHCP_TIMEOUT, 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun RTLT_REALWOW_COMMAND_INVALID 60*4882a593Smuzhiyun }; 61*4882a593Smuzhiyun 62*4882a593Smuzhiyun struct rtl_realwow_ioctl_struct { 63*4882a593Smuzhiyun __u32 cmd; 64*4882a593Smuzhiyun __u32 offset; 65*4882a593Smuzhiyun __u32 len; 66*4882a593Smuzhiyun union { 67*4882a593Smuzhiyun __u32 data; 68*4882a593Smuzhiyun void *data_buffer; 69*4882a593Smuzhiyun }; 70*4882a593Smuzhiyun }; 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun typedef struct _MP_KCPInfo { 73*4882a593Smuzhiyun u8 DIPv4[4]; 74*4882a593Smuzhiyun u8 MacID[6]; 75*4882a593Smuzhiyun u16 UdpPort[2]; 76*4882a593Smuzhiyun u8 PKTLEN[2]; 77*4882a593Smuzhiyun 78*4882a593Smuzhiyun u16 ackLostCnt; 79*4882a593Smuzhiyun u8 KCP_WakePattern[MAX_RealWoW_Payload]; 80*4882a593Smuzhiyun u8 KCP_AckPacket[MAX_RealWoW_Payload]; 81*4882a593Smuzhiyun u32 KCP_interval; 82*4882a593Smuzhiyun u8 KCP_WakePattern_Len; 83*4882a593Smuzhiyun u8 KCP_AckPacket_Len; 84*4882a593Smuzhiyun u8 KCP_TxPacket[2][KA_TX_PACKET_SIZE]; 85*4882a593Smuzhiyun } MP_KCP_INFO, *PMP_KCP_INFO; 86*4882a593Smuzhiyun 87*4882a593Smuzhiyun typedef struct _KCPInfo { 88*4882a593Smuzhiyun u32 nId; // = id 89*4882a593Smuzhiyun u8 DIPv4[4]; 90*4882a593Smuzhiyun u8 MacID[6]; 91*4882a593Smuzhiyun u16 UdpPort; 92*4882a593Smuzhiyun u16 PKTLEN; 93*4882a593Smuzhiyun } KCPInfo, *PKCPInfo; 94*4882a593Smuzhiyun 95*4882a593Smuzhiyun typedef struct _KCPContent { 96*4882a593Smuzhiyun u32 id; // = id 97*4882a593Smuzhiyun u32 mSec; // = msec 98*4882a593Smuzhiyun u32 size; // =size 99*4882a593Smuzhiyun u8 bPacket[MAX_RealWoW_KCP_SIZE]; // put packet here 100*4882a593Smuzhiyun } KCPContent, *PKCPContent; 101*4882a593Smuzhiyun 102*4882a593Smuzhiyun typedef struct _RealWoWAckPktInfo { 103*4882a593Smuzhiyun u16 ackLostCnt; 104*4882a593Smuzhiyun u16 patterntSize; 105*4882a593Smuzhiyun u8 pattern[MAX_RealWoW_Payload]; 106*4882a593Smuzhiyun } RealWoWAckPktInfo,*PRealWoWAckPktInfo; 107*4882a593Smuzhiyun 108*4882a593Smuzhiyun typedef struct _RealWoWWPInfo { 109*4882a593Smuzhiyun u16 patterntSize; 110*4882a593Smuzhiyun u8 pattern[MAX_RealWoW_Payload]; 111*4882a593Smuzhiyun } RealWoWWPInfo,*PRealWoWWPInfo; 112*4882a593Smuzhiyun 113*4882a593Smuzhiyun int rtl8168_realwow_ioctl(struct net_device *dev, struct ifreq *ifr); 114*4882a593Smuzhiyun void rtl8168_realwow_hw_init(struct net_device *dev); 115*4882a593Smuzhiyun void rtl8168_get_realwow_hw_version(struct net_device *dev); 116*4882a593Smuzhiyun void rtl8168_set_realwow_d3_para(struct net_device *dev); 117*4882a593Smuzhiyun 118*4882a593Smuzhiyun #endif /* _LINUX_R8168_REALWOW_H */ 119