RIOT/sys/coding/doc.txt

/*
 * Copyright (C) 2021 Benjamin Valentin <benjamin.valentin@ml-pa.com>
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    sys_coding Error correction codes
 * @ingroup     sys
 * @brief       Error correction function libraries
 *
 * This module provides functions to generate redundancy data for error
 * correction.
 */
sys/coding: add XOR based coding module This implements the XOR based error-correction code described by Jürgen Fitschen (@jue89) at the RIOT Summit. A parity byte is generated for each 3 payload bytes, then the payload array is transposed by interpreting it as a 2D matrix with height of 3. This is to reduce the chance of consecutive bytes ending up in the same packet. This allows to recover one in 3 lost data packets (if parity packets are received). [0] https://summit.riot-os.org/2021/wp-content/uploads/sites/16/2021/09/s02-01.pdf 2021-10-21 13:32:09 +02:00			`/*`
			`* Copyright (C) 2021 Benjamin Valentin <benjamin.valentin@ml-pa.com>`
			`*`
			`* This file is subject to the terms and conditions of the GNU Lesser`
			`* General Public License v2.1. See the file LICENSE in the top level`
			`* directory for more details.`
			`*/`

			`/**`
			`* @defgroup sys_coding Error correction codes`
			`* @ingroup sys`
			`* @brief Error correction function libraries`
			`*`
			`* This module provides functions to generate redundancy data for error`
			`* correction.`
			`*/`