mirror of https://github.com/qmk/qmk_firmware
277 lines
11 KiB
C
277 lines
11 KiB
C
|
/*
|
||
|
|
LUFA Library
|
||
|
|
Copyright (C) Dean Camera, 2017.
|
||
|
|
|
||
|
|
dean [at] fourwalledcubicle [dot] com
|
||
|
|
www.lufa-lib.org
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*
|
||
|
|
Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
||
|
|
|
||
|
|
Permission to use, copy, modify, distribute, and sell this
|
||
|
|
software and its documentation for any purpose is hereby granted
|
||
|
|
without fee, provided that the above copyright notice appear in
|
||
|
|
all copies and that both that the copyright notice and this
|
||
|
|
permission notice and warranty disclaimer appear in supporting
|
||
|
|
documentation, and that the name of the author not be used in
|
||
|
|
advertising or publicity pertaining to distribution of the
|
||
|
|
software without specific, written prior permission.
|
||
|
|
|
||
|
|
The author disclaims all warranties with regard to this
|
||
|
|
software, including all implied warranties of merchantability
|
||
|
|
and fitness. In no event shall the author be liable for any
|
||
|
|
special, indirect or consequential damages or any damages
|
||
|
|
whatsoever resulting from loss of use, data or profits, whether
|
||
|
|
in an action of contract, negligence or other tortious action,
|
||
|
|
arising out of or in connection with the use or performance of
|
||
|
|
this software.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* Protocol decoders for Ethernet, TCP, IP, ICMP and ARP. Each of these routines
|
||
|
|
accepts a header to the appropriate protocol and prints out pertinent information
|
||
|
|
on the packet through the serial port.
|
||
|
|
|
||
|
|
To disable printing of a specific protocol, define the token NO_DECODE_{Protocol}
|
||
|
|
in the project makefile, and pass it to the compiler using the -D switch.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** \file
|
||
|
|
*
|
||
|
|
* Protocol decoding routines, for the plain-text decoding of Ethernet frames for debugging purposes.
|
||
|
|
* Enabled protocol decoders will print incoming Ethernet frame contents through the USART in a human
|
||
|
|
* readable format.
|
||
|
|
*
|
||
|
|
* Note that the USART is a slow transmission medium, and will slow down packet processing considerably.
|
||
|
|
* Packet decoding routines can be disabled by defining NO_DECODE_{Protocol Name} in the project makefile
|
||
|
|
* and passing it to the compiler via the -D switch.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#include "ProtocolDecoders.h"
|
||
|
|
|
||
|
|
/** Decodes an Ethernet frame header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of an Ethernet frame header
|
||
|
|
*/
|
||
|
|
void DecodeEthernetFrameHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_ETHERNET)
|
||
|
|
Ethernet_Frame_Header_t* FrameHeader = (Ethernet_Frame_Header_t*)InDataStart;
|
||
|
|
|
||
|
|
printf_P(PSTR("\r\n"));
|
||
|
|
|
||
|
|
printf_P(PSTR(" ETHERNET\r\n"));
|
||
|
|
|
||
|
|
if (!(MAC_COMPARE(&FrameHeader->Destination, &ServerMACAddress)) &&
|
||
|
|
!(MAC_COMPARE(&FrameHeader->Destination, &BroadcastMACAddress)))
|
||
|
|
{
|
||
|
|
printf_P(PSTR(" + NOT ADDRESSED TO DEVICE\r\n"));
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
printf_P(PSTR(" + MAC Source : %02X:%02X:%02X:%02X:%02X:%02X\r\n"), FrameHeader->Source.Octets[0],
|
||
|
|
FrameHeader->Source.Octets[1],
|
||
|
|
FrameHeader->Source.Octets[2],
|
||
|
|
FrameHeader->Source.Octets[3],
|
||
|
|
FrameHeader->Source.Octets[4],
|
||
|
|
FrameHeader->Source.Octets[5]);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + MAC Dest: %02X:%02X:%02X:%02X:%02X:%02X\r\n"), FrameHeader->Destination.Octets[0],
|
||
|
|
FrameHeader->Destination.Octets[1],
|
||
|
|
FrameHeader->Destination.Octets[2],
|
||
|
|
FrameHeader->Destination.Octets[3],
|
||
|
|
FrameHeader->Destination.Octets[4],
|
||
|
|
FrameHeader->Destination.Octets[5]);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Protocol: 0x%04x\r\n"), SwapEndian_16(FrameHeader->EtherType));
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Decodes an ARP header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of an ARP packet header
|
||
|
|
*/
|
||
|
|
void DecodeARPHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_ARP)
|
||
|
|
ARP_Header_t* ARPHeader = (ARP_Header_t*)InDataStart;
|
||
|
|
|
||
|
|
printf_P(PSTR(" \\\r\n ARP\r\n"));
|
||
|
|
|
||
|
|
if (!(IP_COMPARE(&ARPHeader->TPA, &ServerIPAddress)) &&
|
||
|
|
!(MAC_COMPARE(&ARPHeader->THA, &ServerMACAddress)))
|
||
|
|
{
|
||
|
|
printf_P(PSTR(" + NOT ADDRESSED TO DEVICE\r\n"));
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Protocol: %x\r\n"), SwapEndian_16(ARPHeader->ProtocolType));
|
||
|
|
printf_P(PSTR(" + Operation: %u\r\n"), SwapEndian_16(ARPHeader->Operation));
|
||
|
|
|
||
|
|
if (SwapEndian_16(ARPHeader->ProtocolType) == ETHERTYPE_IPV4)
|
||
|
|
{
|
||
|
|
printf_P(PSTR(" + SHA MAC: %02X:%02X:%02X:%02X:%02X:%02X\r\n"), ARPHeader->SHA.Octets[0],
|
||
|
|
ARPHeader->SHA.Octets[1],
|
||
|
|
ARPHeader->SHA.Octets[2],
|
||
|
|
ARPHeader->SHA.Octets[3],
|
||
|
|
ARPHeader->SHA.Octets[4],
|
||
|
|
ARPHeader->SHA.Octets[5]);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + SPA IP: %u.%u.%u.%u\r\n"), ARPHeader->SPA.Octets[0],
|
||
|
|
ARPHeader->SPA.Octets[1],
|
||
|
|
ARPHeader->SPA.Octets[2],
|
||
|
|
ARPHeader->SPA.Octets[3]);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + THA MAC: %02X:%02X:%02X:%02X:%02X:%02X\r\n"), ARPHeader->THA.Octets[0],
|
||
|
|
ARPHeader->THA.Octets[1],
|
||
|
|
ARPHeader->THA.Octets[2],
|
||
|
|
ARPHeader->THA.Octets[3],
|
||
|
|
ARPHeader->THA.Octets[4],
|
||
|
|
ARPHeader->THA.Octets[5]);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + TPA IP: %u.%u.%u.%u\r\n"), ARPHeader->TPA.Octets[0],
|
||
|
|
ARPHeader->TPA.Octets[1],
|
||
|
|
ARPHeader->TPA.Octets[2],
|
||
|
|
ARPHeader->TPA.Octets[3]);
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Decodes an IP header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of an IP packet header
|
||
|
|
*/
|
||
|
|
void DecodeIPHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_IP)
|
||
|
|
IP_Header_t* IPHeader = (IP_Header_t*)InDataStart;
|
||
|
|
|
||
|
|
uint16_t HeaderLengthBytes = (IPHeader->HeaderLength * sizeof(uint32_t));
|
||
|
|
|
||
|
|
printf_P(PSTR(" \\\r\n IP\r\n"));
|
||
|
|
|
||
|
|
if (!(IP_COMPARE(&IPHeader->DestinationAddress, &ServerIPAddress)))
|
||
|
|
{
|
||
|
|
printf_P(PSTR(" + NOT ADDRESSED TO DEVICE\r\n"));
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Header Length: %u Bytes\r\n"), HeaderLengthBytes);
|
||
|
|
printf_P(PSTR(" + Packet Version: %u\r\n"), IPHeader->Version);
|
||
|
|
printf_P(PSTR(" + Total Length: %u\r\n"), SwapEndian_16(IPHeader->TotalLength));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Protocol: %u\r\n"), IPHeader->Protocol);
|
||
|
|
printf_P(PSTR(" + TTL: %u\r\n"), IPHeader->TTL);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + IP Src: %u.%u.%u.%u\r\n"), IPHeader->SourceAddress.Octets[0],
|
||
|
|
IPHeader->SourceAddress.Octets[1],
|
||
|
|
IPHeader->SourceAddress.Octets[2],
|
||
|
|
IPHeader->SourceAddress.Octets[3]);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + IP Dst: %u.%u.%u.%u\r\n"), IPHeader->DestinationAddress.Octets[0],
|
||
|
|
IPHeader->DestinationAddress.Octets[1],
|
||
|
|
IPHeader->DestinationAddress.Octets[2],
|
||
|
|
IPHeader->DestinationAddress.Octets[3]);
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Decodes an ICMP header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of an ICMP packet header
|
||
|
|
*/
|
||
|
|
void DecodeICMPHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_ICMP)
|
||
|
|
ICMP_Header_t* ICMPHeader = (ICMP_Header_t*)InDataStart;
|
||
|
|
|
||
|
|
printf_P(PSTR(" \\\r\n ICMP\r\n"));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Type: %u\r\n"), ICMPHeader->Type);
|
||
|
|
printf_P(PSTR(" + Code: %u\r\n"), ICMPHeader->Code);
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Decodes a TCP header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of a TCP packet header
|
||
|
|
*/
|
||
|
|
void DecodeTCPHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_TCP)
|
||
|
|
TCP_Header_t* TCPHeader = (TCP_Header_t*)InDataStart;
|
||
|
|
|
||
|
|
uint16_t HeaderLengthBytes = (TCPHeader->DataOffset * sizeof(uint32_t));
|
||
|
|
|
||
|
|
printf_P(PSTR(" \\\r\n TCP\r\n"));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Header Length: %u Bytes\r\n"), HeaderLengthBytes);
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Source Port: %u\r\n"), SwapEndian_16(TCPHeader->SourcePort));
|
||
|
|
printf_P(PSTR(" + Destination Port: %u\r\n"), SwapEndian_16(TCPHeader->DestinationPort));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Sequence Number: %lu\r\n"), SwapEndian_32(TCPHeader->SequenceNumber));
|
||
|
|
printf_P(PSTR(" + Acknowledgment Number: %lu\r\n"), SwapEndian_32(TCPHeader->AcknowledgmentNumber));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Flags: 0x%02X\r\n"), TCPHeader->Flags);
|
||
|
|
|
||
|
|
if (TCP_GetPortState(TCPHeader->DestinationPort) == TCP_Port_Closed)
|
||
|
|
printf_P(PSTR(" + NOT LISTENING ON DESTINATION PORT\r\n"));
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Decodes an UDP header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of a UDP packet header
|
||
|
|
*/
|
||
|
|
void DecodeUDPHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_UDP)
|
||
|
|
UDP_Header_t* UDPHeader = (UDP_Header_t*)InDataStart;
|
||
|
|
|
||
|
|
printf_P(PSTR(" \\\r\n UDP\r\n"));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Source Port: %u\r\n"), SwapEndian_16(UDPHeader->SourcePort));
|
||
|
|
printf_P(PSTR(" + Destination Port: %u\r\n"), SwapEndian_16(UDPHeader->DestinationPort));
|
||
|
|
|
||
|
|
printf_P(PSTR(" + Data Length: %d\r\n"), SwapEndian_16(UDPHeader->Length));
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Decodes an DHCP header and prints its contents to through the USART in a human readable format.
|
||
|
|
*
|
||
|
|
* \param[in] InDataStart Pointer to the start of a DHCP packet header
|
||
|
|
*/
|
||
|
|
void DecodeDHCPHeader(void* InDataStart)
|
||
|
|
{
|
||
|
|
#if !defined(NO_DECODE_DHCP)
|
||
|
|
uint8_t* DHCPOptions = ((uint8_t*)InDataStart + sizeof(DHCP_Header_t));
|
||
|
|
|
||
|
|
printf_P(PSTR(" \\\r\n DHCP\r\n"));
|
||
|
|
|
||
|
|
while (DHCPOptions[0] != DHCP_OPTION_END)
|
||
|
|
{
|
||
|
|
if (DHCPOptions[0] == DHCP_OPTION_MESSAGETYPE)
|
||
|
|
{
|
||
|
|
switch (DHCPOptions[2])
|
||
|
|
{
|
||
|
|
case DHCP_MESSAGETYPE_DISCOVER:
|
||
|
|
printf_P(PSTR(" + DISCOVER\r\n"));
|
||
|
|
break;
|
||
|
|
case DHCP_MESSAGETYPE_REQUEST:
|
||
|
|
printf_P(PSTR(" + REQUEST\r\n"));
|
||
|
|
break;
|
||
|
|
case DHCP_MESSAGETYPE_RELEASE:
|
||
|
|
printf_P(PSTR(" + RELEASE\r\n"));
|
||
|
|
break;
|
||
|
|
case DHCP_MESSAGETYPE_DECLINE:
|
||
|
|
printf_P(PSTR(" + DECLINE\r\n"));
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
DHCPOptions += ((DHCPOptions[0] == DHCP_OPTION_PAD) ? 1 : (DHCPOptions[1] + 2));
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
}
|
||
|
|
|