aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHolger Hans Peter Freyther <holger@moiji-mobile.com>2013-08-07 11:09:43 +0200
committerHolger Hans Peter Freyther <holger@moiji-mobile.com>2013-08-07 11:10:57 +0200
commit94b2f64ae735b85e7b7c42a76b5456dd09e00b2b (patch)
tree5ca09d83f0319952bff5c97c67d2568b7bc7bce0
parentcd195fa267b1869156e6d675032fdafe3035bf5e (diff)
gsm: Try to clarify why we have gsm_septet_encode in the header file
These functions are not meant to be used by applications and are only here for the unit tests. Try to document that.
-rw-r--r--include/osmocom/gsm/gsm_utils.h1
1 files changed, 1 insertions, 0 deletions
diff --git a/include/osmocom/gsm/gsm_utils.h b/include/osmocom/gsm/gsm_utils.h
index 308803d..cf63ea4 100644
--- a/include/osmocom/gsm/gsm_utils.h
+++ b/include/osmocom/gsm/gsm_utils.h
@@ -60,6 +60,7 @@ int gsm_7bit_decode(char *decoded, const uint8_t *user_data, uint8_t length);
int gsm_7bit_decode_hdr(char *decoded, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind);
int gsm_7bit_encode(uint8_t *result, const char *data);
+/* the three functions below are helper functions and here for the unit test */
int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding);
int gsm_septet_encode(uint8_t *result, const char *data);
uint8_t gsm_get_octet_len(const uint8_t sept_len);