doc/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.pdf

doc/Makefile

@@ -0,0 +1,2 @@
+hamnet70.html: hamnet70.adoc
+	asciidoctor $<

doc/hamnet70.adoc

@@ -0,0 +1,244 @@
+= Hamnet70: IP-based networking in the 70 cm amateur radio band
+Thomas Kolb DL5TKL
+0.1, 2024-04-25
+:toc:
+
+== Introduction
+
+== General Notes
+
+All data is transmitted in network byte order (big endian = MSB first).
+
+== Layer 1: Physical Layer
+
+The Physical Layer (PHY) is responsible for encoding a Layer 2 packet such that
+it can be transmitted over the air. Therefore, it encodes and modulates the
+data, and adds a fixed preamble to aid synchronization to the signal.
+Additionally, a mechanism is defined that allows to group packets in a „burst“,
+which reduces overhead.
+
+[#phy_packet_format]
+=== PHY Packet Format
+
+A packet encoded by the PHY consists of the following blocks:
+
+. Preamble: a fixed symbol sequence that the receiver can use to determine the start time, frequency and phase offset of the following data.
+. PHY header: contains information about the packet length and modulation/coding scheme.
+. Data symbols: encoded and modulated data.
+
+==== Preamble
+
+The preamble is a fixed 63-bit sequence generated from a linear feedback shift register with 6 bits and the generator polynomial stem:[x^6 + x^5 + 1].
+
+The generated sequence is: `111000101111001010001100001000001111110101011001101110110100100`.
+
+This sequence is modulated using BPSK.
+
+The preamble is prefixed to each transmitted packet, even inside a burst.
+
+==== PHY Header
+
+The PHY header describes how the following data symbols should be interpreted. It consists of the following fields:
+
+. Modulation/code combination ID (MODCOD): 4 bit
+. Number of data symbols: 12 bit
+. CRC8 of the previous 16 header bits: 8 bit
+
+Therefore the PHY header has as size of 24 bit, including CRC.
+
+For additional protection, the header is encoded using a [8,4] Hamming code, which can reliably correct single-bit errors and detect double-bit errors in every block of four bits.
+
+The PHY header is always modulated using QPSK.
+
+===== Modulation/code combinations
+
+The following table lists all supported combinations of modulation and forward error correction for the packet data.
+
+[options="header"]
+.Supported packet data modulation/code combinations (MODCODs)
+|===
+| ID (binary) | Modulation | Channel Code
+
+| 0000
+| 16-QAM
+| Punctured convolutional code: stem:[r=3/4], stem:[K=7]
+
+| 0001
+| QPSK
+| Punctured convolutional code: stem:[r=3/4], stem:[K=7]
+
+| _others_
+| _reserved_
+| _reserved_
+|===
+
+==== Data Whitening
+
+The IP packets transferred by Hamnet70 may contain long sequences of identical bytes (think of the zeros in the middle of IPv6 addresses), which make it hard to keep the system synchronized. To prevent the transmission of many identical symbols in a row, the data is whitened using a pseudo-random sequence.
+
+Here, a 9-bit linear feedback shift register (LFSR) according to the CCITT specification is used to generate the pseudo-random sequence. The generator polynomial is stem:[x^9 + x^5 + 1]. The data is whitened by XORing data bytes with the _whitening key_ generated from the LFSR.
+
+The whitening key is generated by taking the LSB of the LFSR state, and shifting it into an 8-bit register from the right. Then the LFSR is advanced and the process is repeated. Every 8 repetitions the contents of the 8-bit register are XORed with a data byte to calculate the whitened data.
+
+To remove the whitening, the same procedure is applied to the whitened data at the receiver side. XORing with the same sequence results in the original data.
+
+Whitening is only applied to the layer 2 packet data, but not the PHY header.
+
+==== Data Modulation
+
+The first data symbol follows directly after the last symbol of the PHY header. The data is encoded and modulated using the scheme defined in the PHY header’s MODCOD field. The number of symbols resulting from the encoding and modulation process is stored in the PHY header as well.
+
+=== Burst Transmission
+
+Packets are transmitted in bursts which can combine multiple packets in a contiguous transmission.
+
+A burst consists of the following elements:
+
+. Ramp-up sequence
+. Pre-packet idle sequence (optional)
+. One or more packets as defined in <<phy_packet_format>>
+. Ramp-down sequence
+
+The ramp-up, ramp-down and idle sequences consist of alternating +1/-1 BPSK symbols.
+
+During ramp-up, their amplitude stem:[A_u(k)] is scaled up across stem:[L_u] symbols, following the curve stem:[A_u(k) = sin(π/2 * k / L_u)]. Ramp-down follows a similar sinusoidal for stem:[L_d] symbols: stem:[A_d(k) = cos(π/2 * k / L_d)]. The purpose of these sequences is to avoid splatter while turning on and off the transmitted signal.
+
+During the pre-packet idle sequence, the alternating BPSK symbols are continued with constant amplitude 1.0. This sequence may help synchronizers acquire the signal better (especially the gain and timing regulation can benefit), but is not needed if they are fast enough. If and how this part is used is still to be determined.
+
+Each packet in a burst includes a preamble. Packets are directly concatenated, i.e. after the last data symbol follows the first preamble symbol.
+
+=== Pulse Forming
+
+Pulse forming is applied to limit the bandwidth of the transmitted signal and to reduce inter-symbol interference at the receiver.
+
+This system uses Root Raised Cosine (RRC) filters with a roll-off factor of stem:[alpha=0.2]. Therefore the bandwidth is 1.2 times the symbol rate.
+
+The filter is applied to the whole symbol sequence of the burst. The same filter must be applied at the receiver to minimize inter-symbol interference.
+
+== Layer 2: Link Layer
+
+The Hamnet70 link layer is designed to ensure reliable communication between a central station (digipeater) and several clients, while making efficient use of the available airtime. To accomplish this, it uses several technologies, including variable-length addressing and automatic repetition of packets that could not be decoded.
+
+=== Frame Structure
+
+The link layer frame consist of three elements, as follows:
+
+. The <<_link_layer_header,link layer header>>
+. A variable amount of data, depending on the packet type
+. CRC16 of all previous bytes, including the link layer header
+
+The CRC16 is calculated using the generator polynomial stem:[x^15 + x^2 + 1].
+
+=== Node Addresses
+
+Node addresses use the https://github.com/arngll/arnce-spec/blob/main/n6drc-arnce.md#introduction[HAM-64 address format]. This format allows to encode callsigns of up to 12 characters in a number of 16, 32, 48 or 64 bits. Additionally, it allows to replace the full version of an address with a temporary short address with only 16 bits that is used during a connection. Multicast and broadcast addresses are also specified.
+
+=== Link Layer Header
+
+Each layer 2 packet contains a header that identifies how the message should be interpreted. It is of variable length and composed as follows:
+
+[cols="2,1,5", options="header"]
+.Link layer header layout
+|===
+| Field | Length | Description
+
+| Message type
+| 3 bit
+| The type of the message. See below for a list of values.
+
+| TX request
+| 1 bit
+| After this message, the burst ends and the destination may transmit.
+
+| Source address length
+| 2 bit
+| Length of the source address.
+
+| Destination address length
+| 2 bit
+| Length of the destination address.
+
+| TX sequence number
+| 4 bit
+| Sequence number of the currently transmitted packet.
+
+| RX sequence number
+| 4 bit
+| Sequence number of the packet expected next.
+
+| Source address
+| 16, 32, 48 or 64 bit
+| HAM-64 address identifying the sending station.
+
+| Destination address length
+| 16, 32, 48 or 64 bit
+| HAM-64 address identifying the target station.
+|===
+
+The total Link Layer Header length is therefore at least 6 byte and at most 18 byte.
+
+[cols="1,2,5", options="header"]
+.Message types
+|===
+| Value | Name | Description
+
+| `000`
+| Data frame
+| A regular data packet (inside a connection).
+
+| `001`
+| Connection management
+| Includes functions such as establishing (or denying) new connections or closing open connections.
+
+| `100`
+| Connectionless frame
+| A data packet that is sent outside of a connection.
+
+| _other_
+| _reserved_
+| All values not explicitly listed are reserved and shall be ignored by receivers.
+
+|===
+
+The length of the source and destination addresses is encoded as follows: `00` = 16 bit, `01` = 32 bit, `10` = 48 bit, `11` = 64 bit.
+
+=== Automatic Packet Repetition
+
+Lost packets are automatically repeated in Hamnet70. As the system is also designed for high throughput, it uses the Go-Back-N algorithm to handle this. The algorithm is described in this section.
+
+Both the digipeater and the client send two sequence numbers with each packet.
+
+The _TX sequence number_ is the number of the current packet. It uniquely identifies that packet at the time it is transmitted. The _TX sequence number_ is incremented (with overflow) with each new packet that is sent.
+
+The _RX sequence number_ is the packet number the sending station expects to see next from the other side. It is incremented when a packet with this expected sequence number is decoded successfully. Received packets with other sequence numbers than the expected one must be dropped.
+
+Example: The two stations A and B just connected and expect to see sequence number 0 from each other. Station A transmits a burst with three packets: P0, P1, P2. Station B decodes packet P0 and increases the expected number to 1. P1 is not decoded due to noise and therefore lost. P2 is again decoded, but is dropped because its sequence number is 2 and not the expected 1. In its transmission cycle, station B tells station A that it expects P1 next. Station A therefore _goes back to_ P1 in its transmission queue and starts transmitting all packets after P1 again.
+
+As the sequence numbers in Hamnet70 have 4 bits, up to 15 packets can be transmitted in a burst before the numbers become ambiguous.
+
+Due to the long possible bursts, this system can achieve high throughput if there is low packet loss. However, it can also become very slow if many packets are lost because all packets after the first error have to be repeated. Therefore it might be a good idea to adjust the burst length depending on the packet loss and send smaller bursts if only few packets go through.
+
+=== Ideas
+
+To be defined:
+- connection establishment procedure (request, response)
+- when are new clients allowed to connect?
+- handling of packets from unknown clients that are not connection requests
+- signal quality handling
+
+== Higher Layer Protocols
+
+[appendix]
+== Modulation Details
+
+=== BPSK
+
+In binary phase shift keying, a `1` bit is sent as -1.0 and a `0` bit is sent as +1.0.
+
+=== QPSK
+
+tbd.
+
+=== 16-QAM
+
+tbd.