create CliUint type to match internal embedded cli buffer type, ensuring 32bit vs 64bit etc alignment.

resolves:
#2

Author: mattheweshleman

services/embeddedCliService/include/embeddedCliService.hpp

@@ -32,6 +32,19 @@ struct EmbeddedCliConfig;
 namespace cms {
 namespace EmbeddedCLI { //note, all caps CLI needed to avoid conflicts
 
+// used for proper alignment of cli buffer, below
+// matches with embedded cli itself
+#if UINTPTR_MAX == 0xFFFF
+using CliUint = uint16_t;
+#elif UINTPTR_MAX == 0xFFFFFFFF
+using CliUint = uint32_t;
+#elif UINTPTR_MAX == 0xFFFFFFFFFFFFFFFFu
+using CliUint = uint64_t;
+#else
+    #error unsupported pointer size
+#endif
+
+
 /**
  * The EmbeddedCLI::Service creates a command line interface
  * using a provided character device.
@@ -52,7 +65,7 @@ class Service final : public QP::QActive {
      * @param customInvitation - a custom string for the CLI prompt.
      *                           Set to nullptr for the internal default prompt
      */
-    explicit Service(uint64_t* buffer, size_t bufferElementCount, uint16_t maxBindingCount, const char * customInvitation = nullptr);
+    explicit Service(CliUint* buffer, size_t bufferElementCount, uint16_t maxBindingCount, const char * customInvitation = nullptr);
     ~Service();
 
     Service(const Service&)            = delete;
@@ -67,15 +80,6 @@ class Service final : public QP::QActive {
      * to the AO to get the CLI up and running.
      *
      * @param charDevice - the character device to use
-     * @param buffer - pointer to a statically allocated buffer using
-     *                 uint64. Must be aligned to uint64 boundaries too.
-     * @param bufferElementCount - the number of uint64 elements
-     *                             available at 'buffer'
-     *
-     * @note: If 'buffer' is nullptr, will use the embedded-cli's default configuration
-     *        which will allocate memory via malloc.
-     * @note: Using uint64 to ensure all embedded-cli alignment requirements
-     *        are met, regardless of environment.
      */
     void BeginCliAsync(cms::interfaces::CharacterDevice* charDevice);
 

services/embeddedCliService/src/embeddedCliService.cpp

@@ -22,7 +22,7 @@ Q_DEFINE_THIS_MODULE("EmbeddedCliService")
 namespace cms {
 namespace EmbeddedCLI {
 
-Service::Service(uint64_t* buffer, size_t bufferElementCount, uint16_t maxBindingCount, const char * customInvitation) :
+Service::Service(CliUint * buffer, size_t bufferElementCount, uint16_t maxBindingCount, const char * customInvitation) :
     QP::QActive(initial),
     mCharacterDevice(nullptr),
     mEmbeddedCliConfigBacking(),
@@ -39,7 +39,7 @@ Service::Service(uint64_t* buffer, size_t bufferElementCount, uint16_t maxBindin
 
     if (buffer != nullptr) {
         mEmbeddedCliConfig->cliBuffer = buffer;
-        mEmbeddedCliConfig->cliBufferSize = bufferElementCount * sizeof(uint64_t);
+        mEmbeddedCliConfig->cliBufferSize = bufferElementCount * sizeof(CliUint);
     }
 
     if (customInvitation != nullptr) {
@@ -55,7 +55,7 @@ Service::Service(uint64_t* buffer, size_t bufferElementCount, uint16_t maxBindin
     // only if we are using that option.
     if (buffer != nullptr) {
         uint16_t requiredSize = embeddedCliRequiredSize(mEmbeddedCliConfig);
-        Q_ASSERT(requiredSize <= bufferElementCount * sizeof(uint64_t));
+        Q_ASSERT(requiredSize <= bufferElementCount * sizeof(CliUint));
     }
 }