From d34e6049c96ce72dbbd20e37cfa45c36300f259b Mon Sep 17 00:00:00 2001
From: Peter Barker <pbarker@barker.dropbear.id.au>
Date: Wed, 29 Nov 2023 13:02:03 +1100
Subject: [PATCH] AP_Math: rename crc_sum8 to crc_sum8_with_carry

the name "sum8" is usually used for "sum all bytes into a uint8_t discarding carry"
---
 libraries/AP_Math/crc.cpp | 2 +-
 libraries/AP_Math/crc.h   | 6 ++++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/libraries/AP_Math/crc.cpp b/libraries/AP_Math/crc.cpp
index 0b283b0515..985a02c290 100644
--- a/libraries/AP_Math/crc.cpp
+++ b/libraries/AP_Math/crc.cpp
@@ -481,7 +481,7 @@ uint32_t crc_crc24(const uint8_t *bytes, uint16_t len)
 }
 
 // simple 8 bit checksum used by FPort
-uint8_t crc_sum8(const uint8_t *p, uint8_t len)
+uint8_t crc_sum8_with_carry(const uint8_t *p, uint8_t len)
 {
     uint16_t sum = 0;
     for (uint8_t i=0; i<len; i++) {
diff --git a/libraries/AP_Math/crc.h b/libraries/AP_Math/crc.h
index b0d3ceccce..e0c024bc15 100644
--- a/libraries/AP_Math/crc.h
+++ b/libraries/AP_Math/crc.h
@@ -35,8 +35,10 @@ uint32_t crc32_small(uint32_t crc, const uint8_t *buf, uint32_t size);
 uint32_t crc_crc24(const uint8_t *bytes, uint16_t len);
 uint16_t crc_crc16_ibm(uint16_t crc_accum, uint8_t *data_blk_ptr, uint16_t data_blk_size);
 
-// checksum used by SPORT/FPort
-uint8_t crc_sum8(const uint8_t *p, uint8_t len);
+// checksum used by SPORT/FPort.  For each byte, adds it to a 16-bit
+// sum, then adds those two bytes together.  Returns the complement of
+// the final sum.
+uint8_t crc_sum8_with_carry(const uint8_t *p, uint8_t len);
 
 // Copyright (C) 2010 Swift Navigation Inc.
 // Contact: Fergus Noble <fergus@swift-nav.com>