utils_tlv_bl.h 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. /*
  2. * Copyright (c) 2016-2022 Bouffalolab.
  3. *
  4. * This file is part of
  5. * *** Bouffalolab Software Dev Kit ***
  6. * (see www.bouffalolab.com).
  7. *
  8. * Redistribution and use in source and binary forms, with or without modification,
  9. * are permitted provided that the following conditions are met:
  10. * 1. Redistributions of source code must retain the above copyright notice,
  11. * this list of conditions and the following disclaimer.
  12. * 2. Redistributions in binary form must reproduce the above copyright notice,
  13. * this list of conditions and the following disclaimer in the documentation
  14. * and/or other materials provided with the distribution.
  15. * 3. Neither the name of Bouffalo Lab nor the names of its contributors
  16. * may be used to endorse or promote products derived from this software
  17. * without specific prior written permission.
  18. *
  19. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  23. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  25. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  26. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29. */
  30. #ifndef __UTILS_TLV_BL_H__
  31. #define __UTILS_TLV_BL_H__
  32. #include <stdint.h>
  33. #include <stdbool.h>
  34. #define CFG_ELEMENT_TYPE_SIZE_BOOLEAN (4)
  35. #define CFG_ELEMENT_TYPE_SIZE_UINT32 (4)
  36. #define UTILS_TLV_BL_ERROR_CODE_BUF_TOO_SMALL (-1)
  37. #define UTILS_TLV_BL_ERROR_CODE_UNKOWN (-2)
  38. // Wi-Fi CFG API
  39. enum CFG_ELEMENT_TYPE {
  40. CFG_ELEMENT_TYPE_UNKNOWN,
  41. CFG_ELEMENT_TYPE_BOOLEAN,
  42. CFG_ELEMENT_TYPE_SINT8,
  43. CFG_ELEMENT_TYPE_UINT8,
  44. CFG_ELEMENT_TYPE_SINT16,
  45. CFG_ELEMENT_TYPE_UINT16,
  46. CFG_ELEMENT_TYPE_SINT32,
  47. CFG_ELEMENT_TYPE_UINT32,
  48. CFG_ELEMENT_TYPE_STRING,
  49. };
  50. enum CFG_ELEMENT_TYPE_OPS
  51. {
  52. CFG_ELEMENT_TYPE_OPS_SET,
  53. CFG_ELEMENT_TYPE_OPS_GET,
  54. CFG_ELEMENT_TYPE_OPS_RESET,
  55. CFG_ELEMENT_TYPE_OPS_DUMP_DEBUG,
  56. CFG_ELEMENT_TYPE_OPS_UNKNOWN,
  57. };
  58. int utils_tlv_bl_pack_bool(uint32_t *buf, int buf_sz, bool val);
  59. int utils_tlv_bl_pack_uint8(uint32_t *buf, int buf_sz, uint8_t val);
  60. int utils_tlv_bl_pack_int8(uint32_t *buf, int buf_sz, int8_t val);
  61. int utils_tlv_bl_pack_uint16(uint32_t *buf, int buf_sz, uint16_t val);
  62. int utils_tlv_bl_pack_int16(uint32_t *buf, int buf_sz, int16_t val);
  63. int utils_tlv_bl_pack_uint32(uint32_t *buf, int buf_sz, uint32_t val);
  64. int utils_tlv_bl_pack_int32(uint32_t *buf, int buf_sz, int32_t val);
  65. int utils_tlv_bl_pack_string(uint32_t *buf, int buf_sz, const char *str);
  66. int utils_tlv_bl_pack_auto(uint32_t *buf, int buf_sz, uint16_t type, void *arg1);
  67. int utils_tlv_bl_unpack_bool(uint32_t *buf, int buf_sz, bool *val);
  68. int utils_tlv_bl_unpack_uint8(uint32_t *buf, int buf_sz, uint8_t *val);
  69. int utils_tlv_bl_unpack_int8(uint32_t *buf, int buf_sz, int8_t *val);
  70. int utils_tlv_bl_unpack_uint16(uint32_t *buf, int buf_sz, uint16_t *val);
  71. int utils_tlv_bl_unpack_int16(uint32_t *buf, int buf_sz, int16_t *val);
  72. int utils_tlv_bl_unpack_uint32(uint32_t *buf, int buf_sz, uint32_t *val);
  73. int utils_tlv_bl_unpack_int32(uint32_t *buf, int buf_sz, int32_t *val);
  74. int utils_tlv_bl_unpack_string(uint32_t *buf, int buf_sz, char *str, int size);
  75. int utils_tlv_bl_unpack_auto(uint32_t *buf, int buf_sz, uint16_t type, void *arg1);
  76. #endif