[4.0.0] Make all functions return sucess status

This is a breaking change for appkeys and hashing functions, hence version bump.

Author: markjfisher

Changelog.md

@@ -2,6 +2,14 @@
 
 ## [Unreleased]
 
+## [4.0.0] - 2024-05-06
+
+Breaking Changes
+
+- [appkey] Update signature of appkey functions to return bool instead of uint8_t
+- [appkey] Change return values of appkey to indicate SUCCESS status to be consistent with other functions
+- [hashing] All hashing/base64 functions have been updated similarly to return bool status of success instead of error
+
 ## [3.0.4] - 2024-05-05
 
 - [apple2] Add appkey support (thanks Eric Carr)

apple2/src/fn_fuji/fuji_appkey_open.c

@@ -2,7 +2,8 @@
 #include "fujinet-fuji.h"
 #include "fujinet-bus-apple2.h"
 
-uint8_t fuji_appkey_open(AppKeyOpen *buffer)
+// Open app-key, returns error status
+bool fuji_appkey_open(AppKeyOpen *buffer)
 {
 	sp_error = sp_get_fuji_id();
 	if (sp_error <= 0) {

apple2/src/fn_fuji/fuji_appkey_read.c

@@ -3,7 +3,8 @@
 #include "fujinet-fuji.h"
 #include "fujinet-bus-apple2.h"
 
-uint8_t fuji_appkey_read(AppKeyRead *buffer)
+// reads the app-key, returns error status
+bool fuji_appkey_read(AppKeyRead *buffer)
 {
 	sp_error = sp_get_fuji_id();
 	if (sp_error <= 0) {

apple2/src/fn_fuji/fuji_appkey_write.c

@@ -3,10 +3,10 @@
 #include "fujinet-bus-apple2.h"
 #include <string.h>
 
-uint8_t fuji_appkey_write(uint16_t count, AppKeyWrite *buffer)
+// writes app-key, returns error status
+bool fuji_appkey_write(uint16_t count, AppKeyWrite *buffer)
 {
 	sp_error = sp_get_fuji_id();
-
 	if (sp_error <= 0) {
 		return false;
 	}

apple2/src/fn_fuji/fuji_base64_decode_compute.c

@@ -1,7 +1,7 @@
 #include <stdint.h>
 #include "fujinet-fuji.h"
 
-uint8_t fuji_base64_decode_compute()
+bool fuji_base64_decode_compute()
 {
-    return 1;
+    return true;
 }

apple2/src/fn_fuji/fuji_base64_decode_input.c

@@ -1,7 +1,7 @@
 #include <stdint.h>
 #include "fujinet-fuji.h"
 
-uint8_t fuji_base64_decode_input(char *s, uint16_t len)
+bool fuji_base64_decode_input(char *s, uint16_t len)
 {
-    return 1;
+    return true;
 }

apple2/src/fn_fuji/fuji_base64_decode_length.c

@@ -1,7 +1,7 @@
 #include <stdint.h>
 #include "fujinet-fuji.h"
 
-uint8_t fuji_base64_decode_length(unsigned long *len)
+bool fuji_base64_decode_length(unsigned long *len)
 {
-    return 1;
+    return true;
 }

apple2/src/fn_fuji/fuji_base64_decode_output.c

@@ -1,7 +1,7 @@
 #include <stdint.h>
 #include "fujinet-fuji.h"
 
-uint8_t fuji_base64_decode_output(char *s, uint16_t len)
+bool fuji_base64_decode_output(char *s, uint16_t len)
 {
-    return 1;
+    return true;
 }

apple2/src/fn_fuji/fuji_base64_encode_compute.c

@@ -3,10 +3,10 @@
 #include "fujinet-fuji.h"
 #include "fujinet-bus-apple2.h"
 
-uint8_t fuji_base64_encode_compute()
+bool fuji_base64_encode_compute()
 {
     // send CTRL command: 0xCF
     // PAYLOAD: N/A
 
-    return sp_control(0, 0xCF);
+    return sp_control(0, 0xCF) == 0;
 }

apple2/src/fn_fuji/fuji_base64_encode_input.c

@@ -4,7 +4,7 @@
 #include "fujinet-fuji.h"
 #include "fujinet-bus-apple2.h"
 
-uint8_t fuji_base64_encode_input(char *s, uint16_t len)
+bool fuji_base64_encode_input(char *s, uint16_t len)
 {
     // send CTRL command: 0xD0
     // PAYLOAD:
@@ -13,6 +13,6 @@ uint8_t fuji_base64_encode_input(char *s, uint16_t len)
 
     if (len > MAX_DATA_LEN) return 1;
     strncpy(sp_payload, s, len);
-    return sp_control(0, 0xD0);
+    return sp_control(0, 0xD0) == 0;
 
 }