src/drivers/net/mlx_ipoib/bit_ops.h

   1 /*
   2   This software is available to you under a choice of one of two
   3   licenses.  You may choose to be licensed under the terms of the GNU
   4   General Public License (GPL) Version 2, available at
   5   <http://www.fsf.org/copyleft/gpl.html>, or the OpenIB.org BSD
   6   license, available in the LICENSE.TXT file accompanying this
   7   software.  These details are also available at
   8   <http://openib.org/license.html>.
   9
  10   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  11   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  12   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  13   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  14   BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  15   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  16   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  17   SOFTWARE.
  18
  19   Copyright (c) 2004 Mellanox Technologies Ltd.  All rights reserved.
  20 */
  21
  22 #ifndef __bit_ops_h__
  23 #define __bit_ops_h__
  24
  25 typedef unsigned long MT_offset_t;
  26 typedef unsigned long MT_size_t;
  27 typedef unsigned char pseudo_bit_t;
  28 struct addr_64_st {
  29         __u32 addr_l;
  30         __u32 addr_h;
  31 };
  32
  33 #define MT_BIT_OFFSET(object_struct,reg_path) \
  34     ((MT_offset_t) &( ((struct object_struct *)(0))-> reg_path ))
  35
  36 #define MT_BIT_SIZE(object_struct,reg_path) \
  37     ((MT_size_t) sizeof( ((struct object_struct *)(0))-> reg_path ))
  38
  39 #define MT_BIT_OFFSET_SIZE(object_struct,reg_path) \
  40     MT_BIT_OFFSET(object_struct,reg_path),MT_BIT_SIZE(object_struct,reg_path)
  41
  42 #define MT_BYTE_OFFSET(object_struct,reg_path) \
  43     ((MT_offset_t) (MT_BIT_OFFSET(object_struct,reg_path)/8))
  44
  45 #define MT_BYTE_SIZE(object_struct,reg_path) \
  46     ((MT_size_t) MT_BIT_SIZE(object_struct,reg_path)/8)
  47
  48 #define MT_BYTE_OFFSET_SIZE(object_struct,reg_path) \
  49     MT_BYTE_OFFSET(object_struct,reg_path),MT_BYTE_SIZE(object_struct,reg_path)
  50
  51 #define MT_STRUCT_SIZE(object_struct) (sizeof(struct object_struct) >> 3)
  52
  53 /*****************************************************************************************
  54  * Bit manipulation macros
  55  *****************************************************************************************/
  56
  57 /* MASK generate a bit mask S bits width */
  58 #define MASK32(S)         ( ((__u32) ~0L) >> (32-(S)) )
  59
  60 /*
  61  * BITS generate a bit mask with bits O+S..O set (assumes 32 bit integer).
  62  *      numbering bits as following:    31........................76543210
  63  */
  64 #define BITS32(O,S)       ( MASK32(S) << (O) )
  65
  66 /*
  67  * MT_EXTRACT32 macro extracts S bits from (__u32)W with offset O
  68  *  and shifts them O places to the right (right justifies the field extracted).
  69  */
  70 #define MT_EXTRACT32(W,O,S)  ( ((W)>>(O)) & MASK32(S) )
  71
  72 /*
  73  * MT_INSERT32 macro inserts S bits with offset O from field F into word W (__u32)
  74  */
  75 #define MT_INSERT32(W,F,O,S) ((W)= ( ( (W) & (~BITS32(O,S)) ) | (((F) & MASK32(S))<<(O)) ))
  76
  77 /*
  78  * MT_EXTRACT_ARRAY32 macro is similar to EXTRACT but works on an array of (__u32),
  79  * thus offset may be larger than 32 (but not size).
  80  */
  81 #define MT_EXTRACT_ARRAY32(A,O,S) MT_EXTRACT32(((__u32*)A)[O >> 5],(O & MASK32(5)),S)
  82
  83 /*
  84  * MT_EXTRACT_ARRAY32_BE macro is similar to EXTRACT but works on an array of (__u32),
  85  * thus offset may be larger than 32 (but not size).
  86  *
  87  * (added by mcb30)
  88  */
  89 #define MT_EXTRACT_ARRAY32_BE(A,O,S) MT_EXTRACT32(be32_to_cpu(((__u32*)A)[O >> 5]),(O & MASK32(5)),S)
  90
  91 /*
  92  * MT_INSERT_ARRAY32 macro is similar to INSERT but works on an array of (__u32),
  93  * thus offset may be larger than 32 (but not size).
  94  */
  95 #define MT_INSERT_ARRAY32(A,F,O,S) MT_INSERT32(((__u32*)A)[O >> 5],F,(O & MASK32(5)),S)
  96
  97 #define INS_FLD(src, a, st, fld) MT_INSERT_ARRAY32(a, src, MT_BIT_OFFSET(st, fld), MT_BIT_SIZE(st, fld))
  98
  99 #define EX_FLD(a, st, fld) MT_EXTRACT_ARRAY32(a, MT_BIT_OFFSET(st, fld), MT_BIT_SIZE(st, fld))
 100
 101 #define EX_FLD_BE(a, st, fld) MT_EXTRACT_ARRAY32_BE(a, MT_BIT_OFFSET(st, fld), MT_BIT_SIZE(st, fld))
 102
 103 /* return the address of the dword holding the field
 104
 105         buf = pointer to buffer where to place the value
 106         st = struct describing the buffer
 107         fld = field in the struct where to insert the value */
 108
 109 #define FLD_DW_ADDR(buf, st, fld) ((__u32 *)((__u32 *)(buf)+(((__u32)(&(((struct st *)(0))->fld))) >> 5)))
 110
 111 /*
 112         val = value to insert
 113         buf = pointer to buffer where to place the value
 114         st = struct describing the buffer
 115         fld = field in the struct where to insert the value */
 116
 117 #define INS_FLD_TO_BE(val, buf, st, fld) \
 118         do { \
 119                 *FLD_DW_ADDR(buf, st, fld) = be32_to_cpu(*FLD_DW_ADDR(buf, st, fld)); \
 120                 INS_FLD(val, buf, st, fld); \
 121                 *FLD_DW_ADDR(buf, st, fld) = cpu_to_be32(*FLD_DW_ADDR(buf, st, fld)); \
 122         } \
 123         while(0)
 124
 125 #define EX_FLD_FROM_BE(buf, st, fld, type) \
 126 ({ \
 127         type field; \
 128                                  \
 129         *FLD_DW_ADDR(buf, st, fld) = be32_to_cpu(*FLD_DW_ADDR(buf, st, fld)); \
 130         field= EX_FLD(buf, st, fld); \
 131         *FLD_DW_ADDR(buf, st, fld) = cpu_to_be32(*FLD_DW_ADDR(buf, st, fld)); \
 132                                                                                                                                                   \
 133         field; \
 134 })
 135
 136
 137
 138 /* Remaining code Copyright Fen Systems Ltd. 2007 */
 139
 140 /**
 141  * Wrapper structure for pseudo_bit_t structures
 142  *
 143  * This structure provides a wrapper around the autogenerated
 144  * pseudo_bit_t structures.  It has the correct size, and also
 145  * encapsulates type information about the underlying pseudo_bit_t
 146  * structure, which allows the MLX_FILL etc. macros to work without
 147  * requiring explicit type information.
 148  */
 149 #define MLX_DECLARE_STRUCT( _structure )                                     \
 150         _structure {                                                         \
 151             union {                                                          \
 152                 uint8_t bytes[ sizeof ( struct _structure ## _st ) / 8 ];    \
 153                 uint32_t dwords[ sizeof ( struct _structure ## _st ) / 32 ]; \
 154                 struct _structure ## _st *dummy[0];                          \
 155             } u;                                                             \
 156         }
 157
 158 /** Get pseudo_bit_t structure type from wrapper structure pointer */
 159 #define MLX_PSEUDO_STRUCT( _ptr )                                            \
 160         typeof ( *((_ptr)->u.dummy[0]) )
 161
 162 /** Bit offset of a field within a pseudo_bit_t structure */
 163 #define MLX_BIT_OFFSET( _structure_st, _field )                              \
 164         offsetof ( _structure_st, _field )
 165
 166 /** Dword offset of a field within a pseudo_bit_t structure */
 167 #define MLX_DWORD_OFFSET( _structure_st, _field )                            \
 168         ( MLX_BIT_OFFSET ( _structure_st, _field ) / 32 )
 169
 170 /** Dword bit offset of a field within a pseudo_bit_t structure
 171  *
 172  * Yes, using mod-32 would work, but would lose the check for the
 173  * error of specifying a mismatched field name and dword index.
 174  */
 175 #define MLX_DWORD_BIT_OFFSET( _structure_st, _index, _field )                \
 176         ( MLX_BIT_OFFSET ( _structure_st, _field ) - ( 32 * (_index) ) )
 177
 178 /** Bit width of a field within a pseudo_bit_t structure */
 179 #define MLX_BIT_WIDTH( _structure_st, _field )                               \
 180         sizeof ( ( ( _structure_st * ) NULL )->_field )
 181
 182 /** Bit mask for a field within a pseudo_bit_t structure */
 183 #define MLX_BIT_MASK( _structure_st, _field )                                \
 184         ( ( ~( ( uint32_t ) 0 ) ) >>                                         \
 185           ( 32 - MLX_BIT_WIDTH ( _structure_st, _field ) ) )
 186
 187 /*
 188  * Assemble native-endian dword from named fields and values
 189  *
 190  */
 191
 192 #define MLX_ASSEMBLE_1( _structure_st, _index, _field, _value )              \
 193         ( (_value) << MLX_DWORD_BIT_OFFSET ( _structure_st, _index, _field ) )
 194
 195 #define MLX_ASSEMBLE_2( _structure_st, _index, _field, _value, ... )         \
 196         ( MLX_ASSEMBLE_1 ( _structure_st, _index, _field, _value ) |         \
 197           MLX_ASSEMBLE_1 ( _structure_st, _index, __VA_ARGS__ ) )
 198
 199 #define MLX_ASSEMBLE_3( _structure_st, _index, _field, _value, ... )         \
 200         ( MLX_ASSEMBLE_1 ( _structure_st, _index, _field, _value ) |         \
 201           MLX_ASSEMBLE_2 ( _structure_st, _index, __VA_ARGS__ ) )
 202
 203 #define MLX_ASSEMBLE_4( _structure_st, _index, _field, _value, ... )         \
 204         ( MLX_ASSEMBLE_1 ( _structure_st, _index, _field, _value ) |         \
 205           MLX_ASSEMBLE_3 ( _structure_st, _index, __VA_ARGS__ ) )
 206
 207 #define MLX_ASSEMBLE_5( _structure_st, _index, _field, _value, ... )         \
 208         ( MLX_ASSEMBLE_1 ( _structure_st, _index, _field, _value ) |         \
 209           MLX_ASSEMBLE_4 ( _structure_st, _index, __VA_ARGS__ ) )
 210
 211 #define MLX_ASSEMBLE_6( _structure_st, _index, _field, _value, ... )         \
 212         ( MLX_ASSEMBLE_1 ( _structure_st, _index, _field, _value ) |         \
 213           MLX_ASSEMBLE_5 ( _structure_st, _index, __VA_ARGS__ ) )
 214
 215 /*
 216  * Build native-endian (positive) dword bitmasks from named fields
 217  *
 218  */
 219
 220 #define MLX_MASK_1( _structure_st, _index, _field )                          \
 221         ( MLX_BIT_MASK ( _structure_st, _field ) <<                          \
 222           MLX_DWORD_BIT_OFFSET ( _structure_st, _index, _field ) )
 223
 224 #define MLX_MASK_2( _structure_st, _index, _field, ... )                     \
 225         ( MLX_MASK_1 ( _structure_st, _index, _field ) |                     \
 226           MLX_MASK_1 ( _structure_st, _index, __VA_ARGS__ ) )
 227
 228 #define MLX_MASK_3( _structure_st, _index, _field, ... )                     \
 229         ( MLX_MASK_1 ( _structure_st, _index, _field ) |                     \
 230           MLX_MASK_2 ( _structure_st, _index, __VA_ARGS__ ) )
 231
 232 #define MLX_MASK_4( _structure_st, _index, _field, ... )                     \
 233         ( MLX_MASK_1 ( _structure_st, _index, _field ) |                     \
 234           MLX_MASK_3 ( _structure_st, _index, __VA_ARGS__ ) )
 235
 236 #define MLX_MASK_5( _structure_st, _index, _field, ... )                     \
 237         ( MLX_MASK_1 ( _structure_st, _index, _field ) |                     \
 238           MLX_MASK_4 ( _structure_st, _index, __VA_ARGS__ ) )
 239
 240 #define MLX_MASK_6( _structure_st, _index, _field, ... )                     \
 241         ( MLX_MASK_1 ( _structure_st, _index, _field ) |                     \
 242           MLX_MASK_5 ( _structure_st, _index, __VA_ARGS__ ) )
 243
 244 /*
 245  * Populate big-endian dwords from named fields and values
 246  *
 247  */
 248
 249 #define MLX_FILL( _ptr, _index, _assembled )                                 \
 250         do {                                                                 \
 251                 uint32_t *__ptr = &(_ptr)->u.dwords[(_index)];               \
 252                 uint32_t __assembled = (_assembled);                         \
 253                 *__ptr = cpu_to_be32 ( __assembled );                        \
 254         } while ( 0 )
 255
 256 #define MLX_FILL_1( _ptr, _index, ... )                                      \
 257         MLX_FILL ( _ptr, _index, MLX_ASSEMBLE_1 ( MLX_PSEUDO_STRUCT ( _ptr ),\
 258                                                   _index, __VA_ARGS__ ) )
 259
 260 #define MLX_FILL_2( _ptr, _index, ... )                                      \
 261         MLX_FILL ( _ptr, _index, MLX_ASSEMBLE_2 ( MLX_PSEUDO_STRUCT ( _ptr ),\
 262                                                   _index, __VA_ARGS__ ) )
 263
 264 #define MLX_FILL_3( _ptr, _index, ... )                                      \
 265         MLX_FILL ( _ptr, _index, MLX_ASSEMBLE_3 ( MLX_PSEUDO_STRUCT ( _ptr ),\
 266                                                   _index, __VA_ARGS__ ) )
 267
 268 #define MLX_FILL_4( _ptr, _index, ... )                                      \
 269         MLX_FILL ( _ptr, _index, MLX_ASSEMBLE_4 ( MLX_PSEUDO_STRUCT ( _ptr ),\
 270                                                   _index, __VA_ARGS__ ) )
 271
 272 #define MLX_FILL_5( _ptr, _index, ... )                                      \
 273         MLX_FILL ( _ptr, _index, MLX_ASSEMBLE_5 ( MLX_PSEUDO_STRUCT ( _ptr ),\
 274                                                   _index, __VA_ARGS__ ) )
 275
 276 #define MLX_FILL_6( _ptr, _index, ... )                                      \
 277         MLX_FILL ( _ptr, _index, MLX_ASSEMBLE_6 ( MLX_PSEUDO_STRUCT ( _ptr ),\
 278                                                   _index, __VA_ARGS__ ) )
 279
 280 /*
 281  * Modify big-endian dword using named field and value
 282  *
 283  */
 284
 285 #define MLX_SET( _ptr, _field, _value )                                      \
 286         do {                                                                 \
 287                 unsigned int __index =                                       \
 288                     MLX_DWORD_OFFSET ( MLX_PSEUDO_STRUCT ( _ptr ), _field ); \
 289                 uint32_t *__ptr = &(_ptr)->u.dwords[__index];                \
 290                 uint32_t __value = be32_to_cpu ( *__ptr );                   \
 291                 __value &= ~( MLX_MASK_1 ( MLX_PSEUDO_STRUCT ( _ptr ),       \
 292                                            __index, _field ) );              \
 293                 __value |= MLX_ASSEMBLE_1 ( MLX_PSEUDO_STRUCT ( _ptr ),      \
 294                                             __index, _field, _value );       \
 295                 *__ptr = cpu_to_be32 ( __value );                            \
 296         } while ( 0 )
 297
 298 /*
 299  * Extract value of named field
 300  *
 301  */
 302
 303 #define MLX_GET( _ptr, _field )                                              \
 304         ( {                                                                  \
 305                 unsigned int __index =                                       \
 306                     MLX_DWORD_OFFSET ( MLX_PSEUDO_STRUCT ( _ptr ), _field ); \
 307                 uint32_t *__ptr = &(_ptr)->u.dwords[__index];                \
 308                 uint32_t __value = be32_to_cpu ( *__ptr );                   \
 309                 __value >>=                                                  \
 310                     MLX_DWORD_BIT_OFFSET ( MLX_PSEUDO_STRUCT ( _ptr ),       \
 311                                             __index, _field );               \
 312                 __value &=                                                   \
 313                     MLX_BIT_MASK ( MLX_PSEUDO_STRUCT ( _ptr ), _field );     \
 314                 __value;                                                     \
 315         } )
 316
 317 #endif                          /* __bit_ops_h__ */