1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2014-2019 Broadcom
10 #include "ulp_template_db_enum.h"
12 #define ULP_BUFFER_ALIGN_8_BYTE 8
13 #define ULP_BUFFER_ALIGN_16_BYTE 16
14 #define ULP_BUFFER_ALIGN_64_BYTE 64
17 * Macros for bitmap sets and gets
18 * These macros can be used if the val are power of 2.
20 #define ULP_BITMAP_SET(bitmap, val) ((bitmap) |= (val))
21 #define ULP_BITMAP_RESET(bitmap, val) ((bitmap) &= ~(val))
22 #define ULP_BITMAP_ISSET(bitmap, val) ((bitmap) & (val))
23 #define ULP_BITMAP_CMP(b1, b2) memcmp(&(b1)->bits, \
24 &(b2)->bits, sizeof((b1)->bits))
26 * Macros for bitmap sets and gets
27 * These macros can be used if the val are not power of 2 and
28 * are simple index values.
30 #define ULP_INDEX_BITMAP_SIZE (sizeof(uint64_t) * 8)
31 #define ULP_INDEX_BITMAP_CSET(i) (1UL << \
32 ((ULP_INDEX_BITMAP_SIZE - 1) - \
33 ((i) % ULP_INDEX_BITMAP_SIZE)))
35 #define ULP_INDEX_BITMAP_SET(b, i) ((b) |= \
36 (1UL << ((ULP_INDEX_BITMAP_SIZE - 1) - \
37 ((i) % ULP_INDEX_BITMAP_SIZE))))
39 #define ULP_INDEX_BITMAP_RESET(b, i) ((b) &= \
40 (~(1UL << ((ULP_INDEX_BITMAP_SIZE - 1) - \
41 ((i) % ULP_INDEX_BITMAP_SIZE)))))
43 #define ULP_INDEX_BITMAP_GET(b, i) (((b) >> \
44 ((ULP_INDEX_BITMAP_SIZE - 1) - \
45 ((i) % ULP_INDEX_BITMAP_SIZE))) & 1)
47 #define ULP_DEVICE_PARAMS_INDEX(tid, dev_id) \
48 (((tid) << BNXT_ULP_LOG2_MAX_NUM_DEV) | (dev_id))
50 /* Macro to convert bytes to bits */
51 #define ULP_BYTE_2_BITS(byte_x) ((byte_x) * 8)
52 /* Macro to convert bits to bytes */
53 #define ULP_BITS_2_BYTE(bits_x) (((bits_x) + 7) / 8)
54 /* Macro to convert bits to bytes with no round off*/
55 #define ULP_BITS_2_BYTE_NR(bits_x) ((bits_x) / 8)
57 /* Macro to round off to next multiple of 8*/
58 #define ULP_BYTE_ROUND_OFF_8(x) (((x) + 7) & ~7)
60 /* Macros to read the computed fields */
61 #define ULP_COMP_FLD_IDX_RD(params, idx) \
62 rte_be_to_cpu_32((params)->comp_fld[(idx)])
64 #define ULP_COMP_FLD_IDX_WR(params, idx, val) \
65 ((params)->comp_fld[(idx)] = rte_cpu_to_be_32((val)))
67 * Making the blob statically sized to 128 bytes for now.
68 * The blob must be initialized with ulp_blob_init prior to using.
70 #define BNXT_ULP_FLMP_BLOB_SIZE (128)
71 #define BNXT_ULP_FLMP_BLOB_SIZE_IN_BITS ULP_BYTE_2_BITS(BNXT_ULP_FLMP_BLOB_SIZE)
73 enum bnxt_ulp_byte_order byte_order;
76 uint8_t data[BNXT_ULP_FLMP_BLOB_SIZE];
77 uint16_t encap_swap_idx;
81 * The data can likely be only 32 bits for now. Just size check
82 * the data when being written.
84 #define ULP_REGFILE_ENTRY_SIZE (sizeof(uint32_t))
85 struct ulp_regfile_entry {
91 struct ulp_regfile_entry entry[BNXT_ULP_REGFILE_INDEX_LAST];
95 * Initialize the regfile structure for writing
97 * regfile [in] Ptr to a regfile instance
99 * returns 0 on error or 1 on success
102 ulp_regfile_init(struct ulp_regfile *regfile);
105 * Read a value from the regfile
107 * regfile [in] The regfile instance. Must be initialized prior to being used
109 * field [in] The field to be read within the regfile.
111 * returns the byte array
114 ulp_regfile_read(struct ulp_regfile *regfile,
115 enum bnxt_ulp_regfile_index field,
119 * Write a value to the regfile
121 * regfile [in] The regfile instance. Must be initialized prior to being used
123 * field [in] The field to be written within the regfile.
125 * data [in] The value is written into this variable. It is going to be in the
126 * same byte order as it was written.
128 * returns zero on error
131 ulp_regfile_write(struct ulp_regfile *regfile,
132 enum bnxt_ulp_regfile_index field,
136 * Initializes the blob structure for creating binary blob
138 * blob [in] The blob to be initialized
140 * bitlen [in] The bit length of the blob
142 * order [in] The byte order for the blob. Currently only supporting
143 * big endian. All fields are packed with this order.
145 * returns 0 on error or 1 on success
148 ulp_blob_init(struct ulp_blob *blob,
150 enum bnxt_ulp_byte_order order);
153 * Add data to the binary blob at the current offset.
155 * blob [in] The blob that data is added to. The blob must
156 * be initialized prior to pushing data.
158 * data [in] A pointer to bytes to be added to the blob.
160 * datalen [in] The number of bits to be added to the blob.
162 * The offset of the data is updated after each push of data.
163 * NULL returned on error.
166 ulp_blob_push(struct ulp_blob *blob,
171 * Add data to the binary blob at the current offset.
173 * blob [in] The blob that data is added to. The blob must
174 * be initialized prior to pushing data.
176 * data [in] 64-bit value to be added to the blob.
178 * datalen [in] The number of bits to be added to the blob.
180 * The offset of the data is updated after each push of data.
181 * NULL returned on error, ptr to pushed data otherwise
184 ulp_blob_push_64(struct ulp_blob *blob,
189 * Add data to the binary blob at the current offset.
191 * blob [in] The blob that data is added to. The blob must
192 * be initialized prior to pushing data.
194 * data [in] 32-bit value to be added to the blob.
196 * datalen [in] The number of bits to be added ot the blob.
198 * The offset of the data is updated after each push of data.
199 * NULL returned on error, pointer pushed value otherwise.
202 ulp_blob_push_32(struct ulp_blob *blob,
207 * Add encap data to the binary blob at the current offset.
209 * blob [in] The blob that data is added to. The blob must
210 * be initialized prior to pushing data.
212 * data [in] value to be added to the blob.
214 * datalen [in] The number of bits to be added to the blob.
216 * The offset of the data is updated after each push of data.
217 * NULL returned on error, pointer pushed value otherwise.
220 ulp_blob_push_encap(struct ulp_blob *blob,
225 * Get the data portion of the binary blob.
227 * blob [in] The blob's data to be retrieved. The blob must be
228 * initialized prior to pushing data.
230 * datalen [out] The number of bits to that are filled.
232 * returns a byte array of the blob data. Returns NULL on error.
235 ulp_blob_data_get(struct ulp_blob *blob,
239 * Extract data from the binary blob using given offset.
241 * blob [in] The blob that data is extracted from. The blob must
242 * be initialized prior to pulling data.
244 * data [in] A pointer to put the data.
245 * data_size [in] size of the data buffer in bytes.
246 *offset [in] - Offset in the blob to extract the data in bits format.
247 * len [in] The number of bits to be pulled from the blob.
249 * Output: zero on success, -1 on failure
252 ulp_blob_pull(struct ulp_blob *blob, uint8_t *data, uint32_t data_size,
253 uint16_t offset, uint16_t len);
256 * Adds pad to an initialized blob at the current offset
258 * blob [in] The blob that data is added to. The blob must
259 * be initialized prior to pushing data.
261 * datalen [in] The number of bits of pad to add
263 * returns the number of pad bits added, -1 on failure
266 ulp_blob_pad_push(struct ulp_blob *blob,
270 * Set the 64 bit swap start index of the binary blob.
272 * blob [in] The blob's data to be retrieved. The blob must be
273 * initialized prior to pushing data.
278 ulp_blob_encap_swap_idx_set(struct ulp_blob *blob);
281 * Perform the encap buffer swap to 64 bit reversal.
283 * blob [in] The blob's data to be used for swap.
288 ulp_blob_perform_encap_swap(struct ulp_blob *blob);
291 * Perform the blob buffer reversal byte wise.
292 * This api makes the first byte the last and
295 * blob [in] The blob's data to be used for swap.
300 ulp_blob_perform_byte_reverse(struct ulp_blob *blob);
303 * Read data from the operand
305 * operand [in] A pointer to a 16 Byte operand
307 * val [in/out] The variable to copy the operand to
309 * bitlen [in] The number of bits to read into val
311 * returns number of bits read, zero on error
314 ulp_operand_read(uint8_t *operand,
319 * copy the buffer in the encap format which is 2 bytes.
320 * The MSB of the src is placed at the LSB of dst.
322 * dst [out] The destination buffer
323 * src [in] The source buffer dst
324 * size[in] size of the buffer.
325 * align[in] The alignment is either 8 or 16.
328 ulp_encap_buffer_copy(uint8_t *dst,
334 * Check the buffer is empty
336 * buf [in] The buffer
337 * size [in] The size of the buffer
339 int32_t ulp_buffer_is_empty(const uint8_t *buf, uint32_t size);
341 /* Function to check if bitmap is zero.Return 1 on success */
342 uint32_t ulp_bitmap_is_zero(uint8_t *bitmap, int32_t size);
344 /* Function to check if bitmap is ones. Return 1 on success */
345 uint32_t ulp_bitmap_is_ones(uint8_t *bitmap, int32_t size);
347 /* Function to check if bitmap is not zero. Return 1 on success */
348 uint32_t ulp_bitmap_notzero(uint8_t *bitmap, int32_t size);
350 #endif /* _ULP_UTILS_H_ */