1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2014-2021 Broadcom
7 #include "bnxt_tf_common.h"
10 * Initialize the regfile structure for writing
12 * regfile [in] Ptr to a regfile instance
14 * returns 0 on error or 1 on success
17 ulp_regfile_init(struct ulp_regfile *regfile)
19 /* validate the arguments */
21 BNXT_TF_DBG(ERR, "invalid argument\n");
22 return 0; /* failure */
24 memset(regfile, 0, sizeof(struct ulp_regfile));
25 return 1; /* Success */
29 * Read a value from the regfile
31 * regfile [in] The regfile instance. Must be initialized prior to being used
33 * field [in] The field to be read within the regfile.
37 * returns size, zero on failure
40 ulp_regfile_read(struct ulp_regfile *regfile,
41 enum bnxt_ulp_regfile_index field,
44 /* validate the arguments */
45 if (!regfile || field >= BNXT_ULP_REGFILE_INDEX_LAST) {
46 BNXT_TF_DBG(ERR, "invalid argument\n");
47 return 0; /* failure */
50 *data = regfile->entry[field].data;
55 * Write a value to the regfile
57 * regfile [in] The regfile instance. Must be initialized prior to being used
59 * field [in] The field to be written within the regfile.
61 * data [in] The value is written into this variable. It is going to be in the
62 * same byte order as it was written.
64 * size [in] The size in bytes of the value beingritten into this
70 ulp_regfile_write(struct ulp_regfile *regfile,
71 enum bnxt_ulp_regfile_index field,
74 /* validate the arguments */
75 if (!regfile || field >= BNXT_ULP_REGFILE_INDEX_LAST) {
76 BNXT_TF_DBG(ERR, "invalid argument\n");
77 return 0; /* failure */
80 regfile->entry[field].data = data;
81 return sizeof(data); /* Success */
85 ulp_bs_put_msb(uint8_t *bs, uint16_t bitpos, uint8_t bitlen, uint8_t val)
87 uint8_t bitoffs = bitpos % 8;
88 uint16_t index = bitpos / 8;
94 mask = ((uint8_t)-1 >> (8 - bitlen));
95 shift = 8 - bitoffs - bitlen;
99 tmp &= ~(mask << shift);
103 tmp &= ~((uint8_t)-1 >> bitoffs);
104 tmp |= val >> -shift;
108 tmp &= ((uint8_t)-1 >> (bitlen - (8 - bitoffs)));
109 tmp |= val << (8 + shift);
115 ulp_bs_put_lsb(uint8_t *bs, uint16_t bitpos, uint8_t bitlen, uint8_t val)
117 uint8_t bitoffs = bitpos % 8;
118 uint16_t index = bitpos / 8;
127 if (bitoffs + bitlen <= 8) {
128 mask = ((1 << bitlen) - 1) << shift;
130 tmp |= ((val << shift) & mask);
133 partial = 8 - bitoffs;
134 mask = ((1 << partial) - 1) << shift;
136 tmp |= ((val << shift) & mask);
140 partial = bitlen - partial;
141 mask = ((1 << partial) - 1);
149 /* Assuming that val is in Big-Endian Format */
151 ulp_bs_push_lsb(uint8_t *bs, uint16_t pos, uint8_t len, uint8_t *val)
157 if (cnt > 0 && !(len % 8))
160 for (i = 0; i < cnt; i++) {
161 ulp_bs_put_lsb(bs, pos, 8, val[cnt - i]);
166 /* Handle the remainder bits */
168 ulp_bs_put_lsb(bs, pos, tlen, val[0]);
172 /* Assuming that val is in Big-Endian Format */
174 ulp_bs_push_msb(uint8_t *bs, uint16_t pos, uint8_t len, uint8_t *val)
177 int cnt = (len + 7) / 8;
180 /* Handle any remainder bits */
186 ulp_bs_put_msb(bs, pos, tmp, val[0]);
191 for (i = 1; i < cnt; i++) {
192 ulp_bs_put_msb(bs, pos, 8, val[i]);
201 * Initializes the blob structure for creating binary blob
203 * blob [in] The blob to be initialized
205 * bitlen [in] The bit length of the blob
207 * order [in] The byte order for the blob. Currently only supporting
208 * big endian. All fields are packed with this order.
210 * returns 0 on error or 1 on success
213 ulp_blob_init(struct ulp_blob *blob,
215 enum bnxt_ulp_byte_order order)
217 /* validate the arguments */
218 if (!blob || bitlen > (8 * sizeof(blob->data))) {
219 BNXT_TF_DBG(ERR, "invalid argument\n");
220 return 0; /* failure */
222 blob->bitlen = bitlen;
223 blob->byte_order = order;
225 memset(blob->data, 0, sizeof(blob->data));
226 return 1; /* Success */
230 * Add data to the binary blob at the current offset.
232 * blob [in] The blob that data is added to. The blob must
233 * be initialized prior to pushing data.
235 * data [in] A pointer to bytes to be added to the blob.
237 * datalen [in] The number of bits to be added to the blob.
239 * The offset of the data is updated after each push of data.
240 * NULL returned on error.
242 #define ULP_BLOB_BYTE 8
243 #define ULP_BLOB_BYTE_HEX 0xFF
244 #define BLOB_MASK_CAL(x) ((0xFF << (x)) & 0xFF)
246 ulp_blob_push(struct ulp_blob *blob,
252 /* validate the arguments */
253 if (!blob || datalen > (uint32_t)(blob->bitlen - blob->write_idx)) {
254 BNXT_TF_DBG(ERR, "invalid argument\n");
255 return 0; /* failure */
258 if (blob->byte_order == BNXT_ULP_BYTE_ORDER_BE)
259 rc = ulp_bs_push_msb(blob->data,
264 rc = ulp_bs_push_lsb(blob->data,
269 BNXT_TF_DBG(ERR, "Failed ro write blob\n");
272 blob->write_idx += datalen;
277 * Insert data into the binary blob at the given offset.
279 * blob [in] The blob that data is added to. The blob must
280 * be initialized prior to pushing data.
282 * offset [in] The offset where the data needs to be inserted.
284 * data [in/out] A pointer to bytes to be added to the blob.
286 * datalen [in] The number of bits to be added to the blob.
288 * The offset of the data is updated after each push of data.
289 * NULL returned on error.
292 ulp_blob_insert(struct ulp_blob *blob, uint32_t offset,
293 uint8_t *data, uint32_t datalen)
296 uint8_t local_data[BNXT_ULP_FLMP_BLOB_SIZE];
299 /* validate the arguments */
300 if (!blob || datalen > (uint32_t)(blob->bitlen - blob->write_idx) ||
301 offset > blob->write_idx) {
302 BNXT_TF_DBG(ERR, "invalid argument\n");
303 return 0; /* failure */
306 mov_len = blob->write_idx - offset;
307 /* If offset and data len are not 8 bit aligned then return error */
308 if (ULP_BITS_IS_BYTE_NOT_ALIGNED(offset) ||
309 ULP_BITS_IS_BYTE_NOT_ALIGNED(datalen)) {
310 BNXT_TF_DBG(ERR, "invalid argument, not aligned\n");
311 return 0; /* failure */
314 /* copy the data so we can move the data */
315 memcpy(local_data, &blob->data[ULP_BITS_2_BYTE_NR(offset)],
316 ULP_BITS_2_BYTE(mov_len));
317 blob->write_idx = offset;
318 if (blob->byte_order == BNXT_ULP_BYTE_ORDER_BE)
319 rc = ulp_bs_push_msb(blob->data,
324 rc = ulp_bs_push_lsb(blob->data,
329 BNXT_TF_DBG(ERR, "Failed ro write blob\n");
332 /* copy the previously stored data */
333 memcpy(&blob->data[ULP_BITS_2_BYTE_NR(offset + datalen)], local_data,
334 ULP_BITS_2_BYTE(mov_len));
335 blob->write_idx += (mov_len + datalen);
340 * Add data to the binary blob at the current offset.
342 * blob [in] The blob that data is added to. The blob must
343 * be initialized prior to pushing data.
345 * data [in] 64-bit value to be added to the blob.
347 * datalen [in] The number of bits to be added to the blob.
349 * The offset of the data is updated after each push of data.
350 * NULL returned on error, pointer pushed value otherwise.
353 ulp_blob_push_64(struct ulp_blob *blob,
357 uint8_t *val = (uint8_t *)data;
360 int size = (datalen + 7) / 8;
362 if (!blob || !data ||
363 datalen > (uint32_t)(blob->bitlen - blob->write_idx)) {
364 BNXT_TF_DBG(ERR, "invalid argument\n");
368 rc = ulp_blob_push(blob, &val[8 - size], datalen);
372 return &val[8 - size];
376 * Add data to the binary blob at the current offset.
378 * blob [in] The blob that data is added to. The blob must
379 * be initialized prior to pushing data.
381 * data [in] 32-bit value to be added to the blob.
383 * datalen [in] The number of bits to be added ot the blob.
385 * The offset of the data is updated after each push of data.
386 * NULL returned on error, pointer pushed value otherwise.
389 ulp_blob_push_32(struct ulp_blob *blob,
393 uint8_t *val = (uint8_t *)data;
395 uint32_t size = ULP_BITS_2_BYTE(datalen);
397 if (!data || size > sizeof(uint32_t)) {
398 BNXT_TF_DBG(ERR, "invalid argument\n");
402 rc = ulp_blob_push(blob, &val[sizeof(uint32_t) - size], datalen);
406 return &val[sizeof(uint32_t) - size];
410 * Add encap data to the binary blob at the current offset.
412 * blob [in] The blob that data is added to. The blob must
413 * be initialized prior to pushing data.
415 * data [in] value to be added to the blob.
417 * datalen [in] The number of bits to be added to the blob.
419 * The offset of the data is updated after each push of data.
420 * NULL returned on error, pointer pushed value otherwise.
423 ulp_blob_push_encap(struct ulp_blob *blob,
427 uint8_t *val = (uint8_t *)data;
428 uint32_t initial_size, write_size = datalen;
431 if (!blob || !data ||
432 datalen > (uint32_t)(blob->bitlen - blob->write_idx)) {
433 BNXT_TF_DBG(ERR, "invalid argument\n");
437 initial_size = ULP_BYTE_2_BITS(sizeof(uint64_t)) -
438 (blob->write_idx % ULP_BYTE_2_BITS(sizeof(uint64_t)));
439 while (write_size > 0) {
440 if (initial_size && write_size > initial_size) {
443 } else if (initial_size && write_size <= initial_size) {
446 } else if (write_size > ULP_BYTE_2_BITS(sizeof(uint64_t))) {
447 size = ULP_BYTE_2_BITS(sizeof(uint64_t));
451 if (!ulp_blob_push(blob, val, size)) {
452 BNXT_TF_DBG(ERR, "push field failed\n");
455 val += ULP_BITS_2_BYTE(size);
462 * Adds pad to an initialized blob at the current offset
464 * blob [in] The blob that data is added to. The blob must
465 * be initialized prior to pushing data.
467 * datalen [in] The number of bits of pad to add
469 * returns the number of pad bits added, -1 on failure
472 ulp_blob_pad_push(struct ulp_blob *blob,
475 if (datalen > (uint32_t)(blob->bitlen - blob->write_idx)) {
476 BNXT_TF_DBG(ERR, "Pad too large for blob\n");
480 blob->write_idx += datalen;
484 /* Get data from src and put into dst using little-endian format */
486 ulp_bs_get_lsb(uint8_t *src, uint16_t bitpos, uint8_t bitlen, uint8_t *dst)
488 uint8_t bitoffs = bitpos % ULP_BLOB_BYTE;
489 uint16_t index = ULP_BITS_2_BYTE_NR(bitpos);
490 uint8_t mask, partial, shift;
493 partial = ULP_BLOB_BYTE - bitoffs;
494 if (bitoffs + bitlen <= ULP_BLOB_BYTE) {
495 mask = ((1 << bitlen) - 1) << shift;
496 *dst = (src[index] & mask) >> shift;
498 mask = ((1 << partial) - 1) << shift;
499 *dst = (src[index] & mask) >> shift;
501 partial = bitlen - partial;
502 mask = ((1 << partial) - 1);
503 *dst |= (src[index] & mask) << (ULP_BLOB_BYTE - bitoffs);
507 /* Assuming that src is in little-Endian Format */
509 ulp_bs_pull_lsb(uint8_t *src, uint8_t *dst, uint32_t size,
510 uint32_t offset, uint32_t len)
513 uint32_t cnt = ULP_BITS_2_BYTE_NR(len);
515 /* iterate bytewise to get data */
516 for (idx = 0; idx < cnt; idx++) {
517 ulp_bs_get_lsb(src, offset, ULP_BLOB_BYTE,
518 &dst[size - 1 - idx]);
519 offset += ULP_BLOB_BYTE;
520 len -= ULP_BLOB_BYTE;
523 /* Extract the last reminder data that is not 8 byte boundary */
525 ulp_bs_get_lsb(src, offset, len, &dst[size - 1 - idx]);
529 * Extract data from the binary blob using given offset.
531 * blob [in] The blob that data is extracted from. The blob must
532 * be initialized prior to pulling data.
534 * data [in] A pointer to put the data.
535 * data_size [in] size of the data buffer in bytes.
536 *offset [in] - Offset in the blob to extract the data in bits format.
537 * len [in] The number of bits to be pulled from the blob.
539 * Output: zero on success, -1 on failure
542 ulp_blob_pull(struct ulp_blob *blob, uint8_t *data, uint32_t data_size,
543 uint16_t offset, uint16_t len)
545 /* validate the arguments */
546 if (!blob || (offset + len) > blob->bitlen ||
547 ULP_BYTE_2_BITS(data_size) < len) {
548 BNXT_TF_DBG(ERR, "invalid argument\n");
549 return -1; /* failure */
552 if (blob->byte_order == BNXT_ULP_BYTE_ORDER_BE) {
553 BNXT_TF_DBG(ERR, "Big endian pull not implemented\n");
554 return -1; /* failure */
556 ulp_bs_pull_lsb(blob->data, data, data_size, offset, len);
561 * Get the data portion of the binary blob.
563 * blob [in] The blob's data to be retrieved. The blob must be
564 * initialized prior to pushing data.
566 * datalen [out] The number of bits to that are filled.
568 * returns a byte array of the blob data. Returns NULL on error.
571 ulp_blob_data_get(struct ulp_blob *blob,
574 /* validate the arguments */
576 BNXT_TF_DBG(ERR, "invalid argument\n");
577 return NULL; /* failure */
579 *datalen = blob->write_idx;
584 * Set the encap swap start index of the binary blob.
586 * blob [in] The blob's data to be retrieved. The blob must be
587 * initialized prior to pushing data.
592 ulp_blob_encap_swap_idx_set(struct ulp_blob *blob)
594 /* validate the arguments */
596 BNXT_TF_DBG(ERR, "invalid argument\n");
597 return; /* failure */
599 blob->encap_swap_idx = blob->write_idx;
603 * Perform the encap buffer swap to 64 bit reversal.
605 * blob [in] The blob's data to be used for swap.
610 ulp_blob_perform_encap_swap(struct ulp_blob *blob)
612 uint32_t i, idx = 0, end_idx = 0, roundoff;
613 uint8_t temp_val_1, temp_val_2;
615 /* validate the arguments */
617 BNXT_TF_DBG(ERR, "invalid argument\n");
618 return; /* failure */
620 idx = ULP_BITS_2_BYTE_NR(blob->encap_swap_idx);
621 end_idx = ULP_BITS_2_BYTE(blob->write_idx);
622 roundoff = ULP_BYTE_2_BITS(ULP_BITS_2_BYTE(end_idx));
623 if (roundoff > end_idx) {
624 blob->write_idx += ULP_BYTE_2_BITS(roundoff - end_idx);
627 while (idx <= end_idx) {
628 for (i = 0; i < 4; i = i + 2) {
629 temp_val_1 = blob->data[idx + i];
630 temp_val_2 = blob->data[idx + i + 1];
631 blob->data[idx + i] = blob->data[idx + 6 - i];
632 blob->data[idx + i + 1] = blob->data[idx + 7 - i];
633 blob->data[idx + 7 - i] = temp_val_2;
634 blob->data[idx + 6 - i] = temp_val_1;
641 * Perform the blob buffer reversal byte wise.
642 * This api makes the first byte the last and
645 * blob [in] The blob's data to be used for swap.
650 ulp_blob_perform_byte_reverse(struct ulp_blob *blob)
652 uint32_t idx = 0, num = 0;
655 /* validate the arguments */
657 BNXT_TF_DBG(ERR, "invalid argument\n");
658 return; /* failure */
661 num = ULP_BITS_2_BYTE_NR(blob->write_idx);
662 for (idx = 0; idx < (num / 2); idx++) {
663 xchar = blob->data[idx];
664 blob->data[idx] = blob->data[(num - 1) - idx];
665 blob->data[(num - 1) - idx] = xchar;
670 * Perform the blob buffer 64 bit word swap.
671 * This api makes the first 4 bytes the last in
672 * a given 64 bit value and vice-versa.
674 * blob [in] The blob's data to be used for swap.
679 ulp_blob_perform_64B_word_swap(struct ulp_blob *blob)
683 uint32_t word_size = ULP_64B_IN_BYTES / 2;
685 /* validate the arguments */
687 BNXT_TF_DBG(ERR, "invalid argument\n");
688 return; /* failure */
690 num = ULP_BITS_2_BYTE(blob->write_idx);
691 for (i = 0; i < num; i = i + ULP_64B_IN_BYTES) {
692 for (j = 0; j < word_size; j++) {
693 xchar = blob->data[i + j];
694 blob->data[i + j] = blob->data[i + j + word_size];
695 blob->data[i + j + word_size] = xchar;
701 * Perform the blob buffer 64 bit byte swap.
702 * This api makes the first byte the last in
703 * a given 64 bit value and vice-versa.
705 * blob [in] The blob's data to be used for swap.
710 ulp_blob_perform_64B_byte_swap(struct ulp_blob *blob)
714 uint32_t offset = ULP_64B_IN_BYTES - 1;
716 /* validate the arguments */
718 BNXT_TF_DBG(ERR, "invalid argument\n");
719 return; /* failure */
721 num = ULP_BITS_2_BYTE(blob->write_idx);
722 for (i = 0; i < num; i = i + ULP_64B_IN_BYTES) {
723 for (j = 0; j < (ULP_64B_IN_BYTES / 2); j++) {
724 xchar = blob->data[i + j];
725 blob->data[i + j] = blob->data[i + offset - j];
726 blob->data[i + offset - j] = xchar;
732 * Read data from the operand
734 * operand [in] A pointer to a 16 Byte operand
736 * val [in/out] The variable to copy the operand to
738 * bytes [in] The number of bytes to read into val
740 * returns number of bits read, zero on error
743 ulp_operand_read(uint8_t *operand,
747 /* validate the arguments */
748 if (!operand || !val) {
749 BNXT_TF_DBG(ERR, "invalid argument\n");
750 return 0; /* failure */
752 memcpy(val, operand, bytes);
757 * copy the buffer in the encap format which is 2 bytes.
758 * The MSB of the src is placed at the LSB of dst.
760 * dst [out] The destination buffer
761 * src [in] The source buffer dst
762 * size[in] size of the buffer.
763 * align[in] The alignment is either 8 or 16.
766 ulp_encap_buffer_copy(uint8_t *dst,
771 uint16_t idx, tmp_size = 0;
784 /* copy 2 bytes at a time. Write MSB to LSB */
785 while ((idx + sizeof(uint16_t)) <= tmp_size) {
787 &src[tmp_size - idx - sizeof(uint16_t)],
789 idx += sizeof(uint16_t);
795 * Check the buffer is empty
797 * buf [in] The buffer
798 * size [in] The size of the buffer
801 int32_t ulp_buffer_is_empty(const uint8_t *buf, uint32_t size)
803 return buf[0] == 0 && !memcmp(buf, buf + 1, size - 1);
806 /* Function to check if bitmap is zero.Return 1 on success */
807 uint32_t ulp_bitmap_is_zero(uint8_t *bitmap, int32_t size)
817 /* Function to check if bitmap is ones. Return 1 on success */
818 uint32_t ulp_bitmap_is_ones(uint8_t *bitmap, int32_t size)
828 /* Function to check if bitmap is not zero. Return 1 on success */
829 uint32_t ulp_bitmap_notzero(uint8_t *bitmap, int32_t size)