tinyengine_function.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  1. /* ----------------------------------------------------------------------
  2. * Project: Tiny Training Engine, MCUNetV3
  3. * Title: tinyengine_function.h
  4. *
  5. * Reference papers:
  6. * - MCUNet: Tiny Deep Learning on IoT Device, NeurIPS 2020
  7. * - MCUNetV2: Memory-Efficient Patch-based Inference for Tiny Deep Learning, NeurIPS 2021
  8. * - MCUNetV3: On-Device Training Under 256KB Memory, NeurIPS 2022
  9. * Contact authors:
  10. * - Wei-Chen Wang, wweichen@mit.edu
  11. * - Wei-Ming Chen, wmchen@mit.edu
  12. * - Ji Lin, jilin@mit.edu
  13. * - Ligeng Zhu, ligeng@mit.edu
  14. * - Song Han, songhan@mit.edu
  15. * - Chuang Gan, ganchuang@csail.mit.edu
  16. *
  17. * Target ISA: ARMv7E-M
  18. * -------------------------------------------------------------------- */
  19. #include <math.h>
  20. #include <stdbool.h>
  21. #include <stdint.h>
  22. #include <stdlib.h>
  23. typedef int8_t q7_t;
  24. typedef uint8_t q8_t;
  25. typedef int16_t q15_t;
  26. typedef uint16_t q16_t;
  27. typedef int32_t q31_t;
  28. typedef uint32_t q32_t;
  29. typedef enum {
  30. STATE_SUCCESS = 0, /* No error */
  31. PARAM_NO_SUPPORT = 1, /* Unsupported parameters */
  32. } tinyengine_status;
  33. typedef struct add_params {
  34. int input_h, input_w, input_c, left_shift;
  35. int input1_offset, input1_multiplier, input1_shift;
  36. int input2_offset, input2_multiplier, input2_shift;
  37. int output_offset, output_multiplier, output_shift;
  38. int quantized_activation_max, quantized_activation_min;
  39. } ADD_params;
  40. #define TN_MAX(A, B) ((A) > (B) ? (A) : (B))
  41. #define TN_MIN(A, B) ((A) < (B) ? (A) : (B))
  42. // bit assignment and check
  43. #define BIT_SET(a, b) ((a) |= (1ULL << (b)))
  44. #define BIT_CLEAR(a, b) ((a) &= ~(1ULL << (b)))
  45. #define BIT_FLIP(a, b) ((a) ^= (1ULL << (b)))
  46. #define BIT_CHECK(a, b) (!!((a) & (1ULL << (b)))) // '!!' to make sure this returns 0 or 1
  47. #define BITMASK_SET(x, mask) ((x) |= (mask))
  48. #define BITMASK_CLEAR(x, mask) ((x) &= (~(mask)))
  49. #define BITMASK_FLIP(x, mask) ((x) ^= (mask))
  50. #define BITMASK_CHECK_ALL(x, mask) (!(~(x) & (mask)))
  51. #define BITMASK_CHECK_ANY(x, mask) ((x) & (mask))
  52. tinyengine_status convolve_1x1_s8(const q7_t *input, const uint16_t input_x, const uint16_t input_y,
  53. const uint16_t input_ch, const q7_t *kernel, const int32_t *bias,
  54. const int32_t *output_shift, const int32_t *output_mult, const int32_t out_offset,
  55. const int32_t input_offset, const int32_t out_activation_min,
  56. const int32_t out_activation_max, q7_t *output, const uint16_t output_x,
  57. const uint16_t output_y, const uint16_t output_ch, q15_t *runtime_buf);
  58. tinyengine_status convolve_1x1_s8_ch8(const q7_t *input, const uint16_t input_x, const uint16_t input_y,
  59. const uint16_t input_ch, const q7_t *kernel, const int32_t *bias,
  60. const int32_t *output_shift, const int32_t *output_mult, const int32_t out_offset,
  61. const int32_t input_offset, const int32_t out_activation_min,
  62. const int32_t out_activation_max, q7_t *output, const uint16_t output_x,
  63. const uint16_t output_y, const uint16_t output_ch, q15_t *runtime_buf);
  64. tinyengine_status convolve_1x1_s8_ch16(const q7_t *input, const uint16_t input_x, const uint16_t input_y,
  65. const uint16_t input_ch, const q7_t *kernel, const int32_t *bias,
  66. const int32_t *output_shift, const int32_t *output_mult,
  67. const int32_t out_offset, const int32_t input_offset,
  68. const int32_t out_activation_min, const int32_t out_activation_max, q7_t *output,
  69. const uint16_t output_x, const uint16_t output_y, const uint16_t output_ch,
  70. q15_t *runtime_buf);
  71. tinyengine_status convolve_1x1_s8_ch24(const q7_t *input, const uint16_t input_x, const uint16_t input_y,
  72. const uint16_t input_ch, const q7_t *kernel, const int32_t *bias,
  73. const int32_t *output_shift, const int32_t *output_mult,
  74. const int32_t out_offset, const int32_t input_offset,
  75. const int32_t out_activation_min, const int32_t out_activation_max, q7_t *output,
  76. const uint16_t output_x, const uint16_t output_y, const uint16_t output_ch,
  77. q15_t *runtime_buf);
  78. tinyengine_status convolve_1x1_s8_ch48(const q7_t *input, const uint16_t input_x, const uint16_t input_y,
  79. const uint16_t input_ch, const q7_t *kernel, const int32_t *bias,
  80. const int32_t *output_shift, const int32_t *output_mult,
  81. const int32_t out_offset, const int32_t input_offset,
  82. const int32_t out_activation_min, const int32_t out_activation_max, q7_t *output,
  83. const uint16_t output_x, const uint16_t output_y, const uint16_t output_ch,
  84. q15_t *runtime_buf);
  85. tinyengine_status convolve_s8_kernel3_inputch3_stride2_pad1(
  86. const q7_t *input, const uint16_t input_x, const uint16_t input_y, const uint16_t input_ch, const q7_t *kernel,
  87. const int32_t *bias, const int32_t *output_shift, const int32_t *output_mult, const int32_t output_offset,
  88. const int32_t input_offset, const int32_t output_activation_min, const int32_t output_activation_max, q7_t *output,
  89. const uint16_t output_x, const uint16_t output_y, const uint16_t output_ch, q15_t *runtime_buf, q15_t *kbuf,
  90. q7_t pad_value);
  91. tinyengine_status add(int size, ADD_params *params, const int8_t *input1_data, const int8_t *input2_data,
  92. int8_t *output_data);
  93. tinyengine_status avg_pooling(const q7_t *input, const uint16_t input_h, const uint16_t input_w, const uint16_t input_c,
  94. const uint16_t sample_h, const uint16_t sample_w, const uint16_t output_h,
  95. const uint16_t output_w, const int32_t out_activation_min,
  96. const int32_t out_activation_max, q7_t *output);
  97. tinyengine_status fully_connected_fp(const float *input, const uint16_t input_x, const uint16_t input_y,
  98. const uint16_t input_ch, const uint16_t output_ch, const float *bias,
  99. const float *weights, float *output);
  100. tinyengine_status statble_softmax_inplace(float *input, const uint16_t length);
  101. tinyengine_status mat_mul_fp(const float *matA, const uint16_t matA_row, const uint16_t matA_col, const float *matB,
  102. const uint16_t matB_col, float *output);
  103. tinyengine_status convolve_s8_kernel3_inputch3_stride2_pad1_fpreq(
  104. const q7_t *input, const uint16_t input_x, const uint16_t input_y, const uint16_t input_ch, const q7_t *kernel,
  105. const int32_t *bias, const float *scales, const int32_t output_offset, const int32_t input_offset,
  106. const int32_t output_activation_min, const int32_t output_activation_max, q7_t *output, const uint16_t output_x,
  107. const uint16_t output_y, const uint16_t output_ch, q15_t *runtime_buf, q15_t *kbuf, q7_t pad_value);
  108. tinyengine_status add_fpreq(int size, const int8_t *input1_data, const float input1_scale, const float input1_zero,
  109. const int8_t *input2_data, const float input2_scale, const float input2_zero,
  110. const float output_scale, const float zero_y, int8_t *output_data);
  111. tinyengine_status add_fpreq_mask(int size, const int8_t *input1_data, const float input1_scale, const float input1_zero,
  112. const int8_t *input2_data, const float input2_scale, const float input2_zero,
  113. const float output_scale, const float zero_y, int8_t *output_data,
  114. int8_t *output_mask);
  115. tinyengine_status add_fpreq_bitmask(int size, const int8_t *input1_data, const float input1_scale,
  116. const float input1_zero, const int8_t *input2_data, const float input2_scale,
  117. const float input2_zero, const float output_scale, const float zero_y,
  118. int8_t *output_data, int8_t *output_mask);
  119. tinyengine_status convolve_1x1_s8_fpreq_mask_partialCH(
  120. const q7_t *input, const uint16_t input_x, const uint16_t input_y, const uint16_t input_ch, const q7_t *kernel_sram,
  121. const q7_t *kernel_flash, const uint16_t first_k_channel, const int32_t *bias, const float *scales,
  122. const int32_t out_offset, const int32_t input_offset, const int32_t out_activation_min,
  123. const int32_t out_activation_max, q7_t *output, q7_t *mask, const uint16_t output_x, const uint16_t output_y,
  124. const uint16_t output_ch, q15_t *runtime_buf);
  125. tinyengine_status patchpadding_convolve_s8_kernel3_inputch3_stride2(
  126. const q7_t *input, const uint16_t input_x, const uint16_t input_y, const uint16_t input_ch, const q7_t *kernel,
  127. const int32_t *bias, const int32_t *output_shift, const int32_t *output_mult, const int32_t output_offset,
  128. const int32_t input_offset, const int32_t output_activation_min, const int32_t output_activation_max, q7_t *output,
  129. const uint16_t output_x, const uint16_t output_y, const uint16_t output_ch, q15_t *runtime_buf, q15_t *kbuf,
  130. q7_t pad_value, const uint16_t pad_t, const uint16_t pad_b, const uint16_t pad_l, const uint16_t pad_r);
  131. tinyengine_status patchpadding_depthwise_kernel3x3_stride1_inplace_CHW(
  132. q7_t *input, const uint16_t input_x, const uint16_t input_y, const uint16_t input_ch, const q7_t *kernel,
  133. const int32_t *bias, const int32_t *biasR, const int32_t *output_shift, const int32_t *output_mult,
  134. const int32_t output_offset, const int32_t input_offset, const int32_t output_activation_min,
  135. const int32_t output_activation_max, q7_t *output, const uint16_t output_x, const uint16_t output_y,
  136. const uint16_t output_ch, q15_t *runtime_buf, q7_t pad_value, const uint16_t pad_t, const uint16_t pad_b,
  137. const uint16_t pad_l, const uint16_t pad_r);
  138. tinyengine_status patchpadding_depthwise_kernel3x3_stride2_inplace_CHW(
  139. q7_t *input, const uint16_t input_x, const uint16_t input_y, const uint16_t input_ch, const q7_t *kernel,
  140. const int32_t *bias, const int32_t *biasR, const int32_t *output_shift, const int32_t *output_mult,
  141. const int32_t output_offset, const int32_t input_offset, const int32_t output_activation_min,
  142. const int32_t output_activation_max, q7_t *output, const uint16_t output_x, const uint16_t output_y,
  143. const uint16_t output_ch, q15_t *runtime_buf, q7_t pad_value, const uint16_t pad_t, const uint16_t pad_b,
  144. const uint16_t pad_l, const uint16_t pad_r);
  145. tinyengine_status element_mult_nx1(const q7_t *input, const uint16_t input_h, const uint16_t input_w,
  146. const uint16_t input_c, const q7_t *input2, const int16_t input1_offset,
  147. const int16_t input2_offset, const int16_t output_offset,
  148. const int32_t out_activation_min, const int32_t out_activation_max,
  149. const float output_scale, q7_t *output);
  150. tinyengine_status upsample_byte(const q7_t *input, const uint16_t input_x,
  151. const uint16_t input_y, const uint16_t input_ch, q7_t *output, const uint16_t sample_factor);
  152. tinyengine_status max_pooling(const q7_t* input, const uint16_t input_h, const uint16_t input_w,
  153. const uint16_t input_c, const uint16_t sample_h, const uint16_t sample_w,
  154. const uint16_t output_h, const uint16_t output_w, const int32_t out_activation_min,
  155. const int32_t out_activation_max, q7_t* output);
  156. q7_t *mat_mult_unloop18_s8_s16(const q7_t *input_a,
  157. const q15_t *input_b,
  158. const uint16_t output_ch,
  159. const int32_t *out_shift,
  160. const int32_t *out_mult,
  161. const int32_t out_offset,
  162. const int16_t activation_min,
  163. const int16_t activation_max,
  164. const uint16_t num_col_a,
  165. const int32_t *const output_bias,
  166. q7_t *out_0,
  167. q15_t *kbuf);
  168. q7_t* mat_mult_kernel_s8_s16_reordered_fpreq_mask_partialCH_Multiple2(const q7_t *kernel_sram,
  169. const q7_t *kernel_flash, const uint16_t first_k_channel,
  170. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  171. const int32_t out_offset, const int16_t activation_min,
  172. const int16_t activation_max, const uint16_t num_col_a,
  173. const int32_t *const output_bias, q7_t *out_0, q7_t *mask);
  174. q7_t* mat_mult_kernel_s8_s16_reordered_fpreq_mask_partialCH(const q7_t *kernel_sram,
  175. const q7_t *kernel_flash, const uint16_t first_k_channel,
  176. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  177. const int32_t out_offset, const int16_t activation_min,
  178. const int16_t activation_max, const uint16_t num_col_a,
  179. const int32_t *const output_bias, q7_t *out_0, q7_t *mask);
  180. q7_t* mat_mult_kernel3_input3_s8_s16_fpreq(const q7_t *input_a,
  181. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  182. const int32_t out_offset, const int16_t activation_min,
  183. const int16_t activation_max, const uint16_t num_col_a,
  184. const int32_t *const output_bias, q7_t *out_0, q15_t *kbuf);
  185. q7_t* mat_mult_kernel_s8_s16_reordered_fpreq_bitmask_partialCH_Multiple2(const q7_t *kernel_sram,
  186. const q7_t *kernel_flash, const uint16_t first_k_channel,
  187. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  188. const int32_t out_offset, const int16_t activation_min,
  189. const int16_t activation_max, const uint16_t num_col_a,
  190. const int32_t *const output_bias, q7_t *out_0, q7_t *mask);
  191. q7_t* mat_mult_kernel_s8_s16_reordered_fpreq_bitmask_partialCH(const q7_t *kernel_sram,
  192. const q7_t *kernel_flash, const uint16_t first_k_channel,
  193. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  194. const int32_t out_offset, const int16_t activation_min,
  195. const int16_t activation_max, const uint16_t num_col_a,
  196. const int32_t *const output_bias, q7_t *out_0, q7_t *mask);
  197. q7_t* mat_mult_kernel_s8_s16_reordered_fpreq_mask(const q7_t *input_a,
  198. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  199. const int32_t out_offset, const int16_t activation_min,
  200. const int16_t activation_max, const uint16_t num_col_a,
  201. const int32_t *const output_bias, q7_t *out_0, q7_t *mask);
  202. q7_t* mat_mult_kernel_s8_s16_reordered_fpreq_bitmask(const q7_t *input_a,
  203. const q15_t *input_b, const uint16_t output_ch, const float *scales,
  204. const int32_t out_offset, const int16_t activation_min,
  205. const int16_t activation_max, const uint16_t num_col_a,
  206. const int32_t *const output_bias, q7_t *out_0, q7_t *mask);
  207. q7_t *mat_mult_kernel_s8_s16_reordered_ch16(const q7_t *input_a,
  208. const q15_t *input_b,
  209. const uint16_t output_ch,
  210. const int32_t *out_shift,
  211. const int32_t *out_mult,
  212. const int32_t out_offset,
  213. const int16_t activation_min,
  214. const int16_t activation_max,
  215. const uint16_t num_col_a,
  216. const int32_t *const output_bias,
  217. q7_t *out_0);
  218. q7_t *mat_mult_kernel_s8_s16_reordered_ch48(const q7_t *input_a,
  219. const q15_t *input_b,
  220. const uint16_t output_ch,
  221. const int32_t *out_shift,
  222. const int32_t *out_mult,
  223. const int32_t out_offset,
  224. const int16_t activation_min,
  225. const int16_t activation_max,
  226. const uint16_t num_col_a,
  227. const int32_t *const output_bias,
  228. q7_t *out_0);
  229. q7_t *mat_mult_kernel_s8_s16_reordered_ch24(const q7_t *input_a,
  230. const q15_t *input_b,
  231. const uint16_t output_ch,
  232. const int32_t *out_shift,
  233. const int32_t *out_mult,
  234. const int32_t out_offset,
  235. const int16_t activation_min,
  236. const int16_t activation_max,
  237. const uint16_t num_col_a,
  238. const int32_t *const output_bias,
  239. q7_t *out_0);
  240. q7_t *mat_mult_s16(const q7_t *input_a,
  241. const q15_t *input_b,
  242. const uint16_t output_ch,
  243. const int32_t *out_shift,
  244. const int32_t *out_mult,
  245. const int32_t out_offset,
  246. const int16_t activation_min,
  247. const int16_t activation_max,
  248. const uint16_t num_col_a,
  249. const int32_t *const output_bias,
  250. q7_t *out_0,
  251. q15_t *kbuf);
  252. q7_t *mat_mult_kernel_s8_s16(const q7_t *input_a,
  253. const q15_t *input_b,
  254. const uint16_t output_ch,
  255. const int32_t *out_shift,
  256. const int32_t *out_mult,
  257. const int32_t out_offset,
  258. const int16_t activation_min,
  259. const int16_t activation_max,
  260. const uint16_t num_col_a,
  261. const int32_t *const output_bias,
  262. q7_t *out_0);
  263. q7_t *mat_mult_kernel_s8_s16_reordered_ch8(const q7_t *input_a,
  264. const q15_t *input_b,
  265. const uint16_t output_ch,
  266. const int32_t *out_shift,
  267. const int32_t *out_mult,
  268. const int32_t out_offset,
  269. const int16_t activation_min,
  270. const int16_t activation_max,
  271. const uint16_t num_col_a,
  272. const int32_t *const output_bias,
  273. q7_t *out_0);
  274. q7_t *hpm_nn_mat_mult_kernel3_input3_s8_s16(const q7_t *input_a,
  275. const q15_t *input_b,
  276. const uint16_t output_ch,
  277. const int32_t *out_shift,
  278. const int32_t *out_mult,
  279. const int32_t out_offset,
  280. const int16_t activation_min,
  281. const int16_t activation_max,
  282. const uint16_t num_col_a,
  283. const int32_t *const output_bias,
  284. q7_t *out_0,
  285. q15_t *kbuf);
  286. q7_t *hpm_nn_mat_mult_kernel_s8_s16_reordered_8mul(const q7_t *input_a,
  287. const q15_t *input_b,
  288. const uint16_t output_ch,
  289. const int32_t *out_shift,
  290. const int32_t *out_mult,
  291. const int32_t out_offset,
  292. const int16_t activation_min,
  293. const int16_t activation_max,
  294. const uint16_t num_col_a,
  295. const int32_t *const output_bias,
  296. q7_t *out_0);
  297. #include "fp_requantize_op.h"
  298. // #include "genInclude.h"
  299. //#include "int8_bp_op.h"