drivers/net/dpaa2/mc/fsl_dpdmux.h

   1 /* SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
   2  *
   3  * Copyright 2013-2016 Freescale Semiconductor Inc.
   4  * Copyright 2018-2021 NXP
   5  *
   6  */
   7 #ifndef __FSL_DPDMUX_H
   8 #define __FSL_DPDMUX_H
   9
  10 #include <fsl_net.h>
  11
  12 struct fsl_mc_io;
  13
  14 /** @addtogroup dpdmux Data Path Demux API
  15  * Contains API for handling DPDMUX topology and functionality
  16  * @{
  17  */
  18
  19 int dpdmux_open(struct fsl_mc_io *mc_io,
  20                 uint32_t  cmd_flags,
  21                 int  dpdmux_id,
  22                 uint16_t  *token);
  23
  24 int dpdmux_close(struct fsl_mc_io *mc_io,
  25                  uint32_t cmd_flags,
  26                  uint16_t token);
  27
  28 /**
  29  * DPDMUX general options
  30  */
  31
  32 /**
  33  * Enable bridging between internal interfaces
  34  */
  35 #define DPDMUX_OPT_BRIDGE_EN    0x0000000000000002ULL
  36
  37 /**
  38  * Mask support for classification
  39  */
  40 #define DPDMUX_OPT_CLS_MASK_SUPPORT             0x0000000000000020ULL
  41
  42 /**
  43  * Automatic max frame length - maximum frame length for dpdmux interface will
  44  * be changed automatically by connected dpni objects.
  45  */
  46 #define DPDMUX_OPT_AUTO_MAX_FRAME_LEN   0x0000000000000040ULL
  47
  48 #define DPDMUX_IRQ_INDEX_IF     0x0000
  49 #define DPDMUX_IRQ_INDEX        0x0001
  50
  51 /**
  52  * IRQ event - Indicates that the link state changed
  53  */
  54 #define DPDMUX_IRQ_EVENT_LINK_CHANGED   0x0001
  55
  56 /**
  57  * enum dpdmux_manip - DPDMUX manipulation operations
  58  * @DPDMUX_MANIP_NONE:  No manipulation on frames
  59  * @DPDMUX_MANIP_ADD_REMOVE_S_VLAN: Add S-VLAN on egress, remove it on ingress
  60  */
  61 enum dpdmux_manip {
  62         DPDMUX_MANIP_NONE = 0x0,
  63         DPDMUX_MANIP_ADD_REMOVE_S_VLAN = 0x1
  64 };
  65
  66 /**
  67  * enum dpdmux_method - DPDMUX method options
  68  * @DPDMUX_METHOD_NONE: no DPDMUX method
  69  * @DPDMUX_METHOD_C_VLAN_MAC: DPDMUX based on C-VLAN and MAC address
  70  * @DPDMUX_METHOD_MAC: DPDMUX based on MAC address
  71  * @DPDMUX_METHOD_C_VLAN: DPDMUX based on C-VLAN
  72  * @DPDMUX_METHOD_S_VLAN: DPDMUX based on S-VLAN
  73  */
  74 enum dpdmux_method {
  75         DPDMUX_METHOD_NONE = 0x0,
  76         DPDMUX_METHOD_C_VLAN_MAC = 0x1,
  77         DPDMUX_METHOD_MAC = 0x2,
  78         DPDMUX_METHOD_C_VLAN = 0x3,
  79         DPDMUX_METHOD_S_VLAN = 0x4,
  80         DPDMUX_METHOD_CUSTOM = 0x5,
  81 };
  82
  83 /**
  84  * struct dpdmux_cfg - DPDMUX configuration parameters
  85  * @method: Defines the operation method for the DPDMUX address table
  86  * @manip: Required manipulation operation
  87  * @num_ifs: Number of interfaces (excluding the uplink interface)
  88  * @default_if: Default interface number (different from uplink,
  89         maximum value num_ifs)
  90  * @adv: Advanced parameters; default is all zeros;
  91  *      use this structure to change default settings
  92  * @adv.options: DPDMUX options - combination of 'DPDMUX_OPT_<X>' flags.
  93  * @adv.max_dmat_entries: Maximum entries in DPDMUX address table
  94  *      0 - indicates default: 64 entries per interface.
  95  * @adv.max_mc_groups: Number of multicast groups in DPDMUX table
  96  *      0 - indicates default: 32 multicast groups.
  97  * @adv.max_vlan_ids: Maximum vlan ids allowed in the system -
  98  *      relevant only case of working in mac+vlan method.
  99  *      0 - indicates default 16 vlan ids.
 100  * @adv.mem_size: Size of the memory used for internal buffers expressed as
 101  * number of 256byte buffers.
 102  */
 103 struct dpdmux_cfg {
 104         enum dpdmux_method method;
 105         enum dpdmux_manip manip;
 106         uint16_t num_ifs;
 107         uint16_t default_if;
 108         struct {
 109                 uint64_t options;
 110                 uint16_t max_dmat_entries;
 111                 uint16_t max_mc_groups;
 112                 uint16_t max_vlan_ids;
 113                 uint16_t mem_size;
 114         } adv;
 115 };
 116
 117 int dpdmux_create(struct fsl_mc_io *mc_io,
 118                   uint16_t dprc_token,
 119                   uint32_t cmd_flags,
 120                   const struct dpdmux_cfg *cfg,
 121                   uint32_t *obj_id);
 122
 123 int dpdmux_destroy(struct fsl_mc_io *mc_io,
 124                    uint16_t dprc_token,
 125                    uint32_t cmd_flags,
 126                    uint32_t object_id);
 127
 128 int dpdmux_enable(struct fsl_mc_io *mc_io,
 129                   uint32_t cmd_flags,
 130                   uint16_t token);
 131
 132 int dpdmux_disable(struct fsl_mc_io *mc_io,
 133                    uint32_t cmd_flags,
 134                    uint16_t token);
 135
 136 int dpdmux_is_enabled(struct fsl_mc_io *mc_io,
 137                       uint32_t cmd_flags,
 138                       uint16_t token,
 139                       int *en);
 140
 141 int dpdmux_reset(struct fsl_mc_io *mc_io,
 142                  uint32_t cmd_flags,
 143                  uint16_t token);
 144
 145 /**
 146  *Setting 1 DPDMUX_RESET will not reset default interface
 147  */
 148 #define DPDMUX_SKIP_DEFAULT_INTERFACE   0x01
 149 /**
 150  *Setting 1 DPDMUX_RESET will not reset unicast rules
 151  */
 152 #define DPDMUX_SKIP_UNICAST_RULES       0x02
 153 /**
 154  *Setting 1 DPDMUX_RESET will not reset multicast rules
 155  */
 156 #define DPDMUX_SKIP_MULTICAST_RULES     0x04
 157
 158 int dpdmux_set_resetable(struct fsl_mc_io *mc_io,
 159                                   uint32_t cmd_flags,
 160                                   uint16_t token,
 161                                   uint8_t skip_reset_flags);
 162
 163 int dpdmux_get_resetable(struct fsl_mc_io *mc_io,
 164                                   uint32_t cmd_flags,
 165                                   uint16_t token,
 166                                   uint8_t *skip_reset_flags);
 167
 168 /**
 169  * struct dpdmux_attr - Structure representing DPDMUX attributes
 170  * @id: DPDMUX object ID
 171  * @options: Configuration options (bitmap)
 172  * @method: DPDMUX address table method
 173  * @manip: DPDMUX manipulation type
 174  * @num_ifs: Number of interfaces (excluding the uplink interface)
 175  * @mem_size: DPDMUX frame storage memory size
 176  * @default_if: Default interface number (different from uplink,
 177         maximum value num_ifs)
 178  */
 179 struct dpdmux_attr {
 180         int id;
 181         uint64_t options;
 182         enum dpdmux_method method;
 183         enum dpdmux_manip manip;
 184         uint16_t num_ifs;
 185         uint16_t mem_size;
 186         uint16_t default_if;
 187 };
 188
 189 int dpdmux_get_attributes(struct fsl_mc_io *mc_io,
 190                           uint32_t cmd_flags,
 191                           uint16_t token,
 192                           struct dpdmux_attr *attr);
 193
 194 int dpdmux_set_max_frame_length(struct fsl_mc_io *mc_io,
 195                                 uint32_t cmd_flags,
 196                                 uint16_t token,
 197                                 uint16_t max_frame_length);
 198
 199 int dpdmux_get_max_frame_length(struct fsl_mc_io *mc_io,
 200                                 uint32_t cmd_flags,
 201                                 uint16_t token,
 202                                 uint16_t if_id,
 203                                 uint16_t *max_frame_length);
 204
 205 /**
 206  * enum dpdmux_counter_type - Counter types
 207  * @DPDMUX_CNT_ING_FRAME: Counts ingress frames
 208  * @DPDMUX_CNT_ING_BYTE: Counts ingress bytes
 209  * @DPDMUX_CNT_ING_FLTR_FRAME: Counts filtered ingress frames
 210  * @DPDMUX_CNT_ING_FRAME_DISCARD: Counts discarded ingress frames
 211  * @DPDMUX_CNT_ING_MCAST_FRAME: Counts ingress multicast frames
 212  * @DPDMUX_CNT_ING_MCAST_BYTE: Counts ingress multicast bytes
 213  * @DPDMUX_CNT_ING_BCAST_FRAME: Counts ingress broadcast frames
 214  * @DPDMUX_CNT_ING_BCAST_BYTES: Counts ingress broadcast bytes
 215  * @DPDMUX_CNT_EGR_FRAME: Counts egress frames
 216  * @DPDMUX_CNT_EGR_BYTE: Counts egress bytes
 217  * @DPDMUX_CNT_EGR_FRAME_DISCARD: Counts discarded egress frames
 218  * @DPDMUX_CNT_ING_NO_BUFFER_DISCARD: Counts ingress no buffer discard frames
 219  */
 220 enum dpdmux_counter_type {
 221         DPDMUX_CNT_ING_FRAME = 0x0,
 222         DPDMUX_CNT_ING_BYTE = 0x1,
 223         DPDMUX_CNT_ING_FLTR_FRAME = 0x2,
 224         DPDMUX_CNT_ING_FRAME_DISCARD = 0x3,
 225         DPDMUX_CNT_ING_MCAST_FRAME = 0x4,
 226         DPDMUX_CNT_ING_MCAST_BYTE = 0x5,
 227         DPDMUX_CNT_ING_BCAST_FRAME = 0x6,
 228         DPDMUX_CNT_ING_BCAST_BYTES = 0x7,
 229         DPDMUX_CNT_EGR_FRAME = 0x8,
 230         DPDMUX_CNT_EGR_BYTE = 0x9,
 231         DPDMUX_CNT_EGR_FRAME_DISCARD = 0xa,
 232         DPDMUX_CNT_ING_NO_BUFFER_DISCARD = 0xb,
 233 };
 234
 235 /**
 236  * enum dpdmux_accepted_frames_type - DPDMUX frame types
 237  * @DPDMUX_ADMIT_ALL: The device accepts VLAN tagged, untagged and
 238  *                      priority-tagged frames
 239  * @DPDMUX_ADMIT_ONLY_VLAN_TAGGED: The device discards untagged frames or
 240  *                              priority-tagged frames that are received on this
 241  *                              interface
 242  * @DPDMUX_ADMIT_ONLY_UNTAGGED: Untagged frames or priority-tagged frames
 243  *                              received on this interface are accepted
 244  */
 245 enum dpdmux_accepted_frames_type {
 246         DPDMUX_ADMIT_ALL = 0,
 247         DPDMUX_ADMIT_ONLY_VLAN_TAGGED = 1,
 248         DPDMUX_ADMIT_ONLY_UNTAGGED = 2
 249 };
 250
 251 /**
 252  * enum dpdmux_action - DPDMUX action for un-accepted frames
 253  * @DPDMUX_ACTION_DROP: Drop un-accepted frames
 254  * @DPDMUX_ACTION_REDIRECT_TO_CTRL: Redirect un-accepted frames to the
 255  *                                      control interface
 256  */
 257 enum dpdmux_action {
 258         DPDMUX_ACTION_DROP = 0,
 259         DPDMUX_ACTION_REDIRECT_TO_CTRL = 1
 260 };
 261
 262 /**
 263  * struct dpdmux_accepted_frames - Frame types configuration
 264  * @type: Defines ingress accepted frames
 265  * @unaccept_act: Defines action on frames not accepted
 266  */
 267 struct dpdmux_accepted_frames {
 268         enum dpdmux_accepted_frames_type type;
 269         enum dpdmux_action unaccept_act;
 270 };
 271
 272 int dpdmux_if_set_accepted_frames(struct fsl_mc_io *mc_io,
 273                                   uint32_t cmd_flags,
 274                                   uint16_t token,
 275                                   uint16_t if_id,
 276                                   const struct dpdmux_accepted_frames *cfg);
 277
 278 /**
 279  * struct dpdmux_if_attr - Structure representing frame types configuration
 280  * @rate: Configured interface rate (in bits per second)
 281  * @enabled: Indicates if interface is enabled
 282  * @accept_frame_type: Indicates type of accepted frames for the interface
 283  */
 284 struct dpdmux_if_attr {
 285         uint32_t rate;
 286         int enabled;
 287         int is_default;
 288         enum dpdmux_accepted_frames_type accept_frame_type;
 289 };
 290
 291 int dpdmux_if_get_attributes(struct fsl_mc_io *mc_io,
 292                              uint32_t cmd_flags,
 293                              uint16_t token,
 294                              uint16_t if_id,
 295                              struct dpdmux_if_attr *attr);
 296
 297 int dpdmux_if_enable(struct fsl_mc_io *mc_io,
 298                      uint32_t cmd_flags,
 299                      uint16_t token,
 300                      uint16_t if_id);
 301
 302 int dpdmux_if_disable(struct fsl_mc_io *mc_io,
 303                       uint32_t cmd_flags,
 304                       uint16_t token,
 305                       uint16_t if_id);
 306
 307 /**
 308  * struct dpdmux_l2_rule - Structure representing L2 rule
 309  * @mac_addr: MAC address
 310  * @vlan_id: VLAN ID
 311  */
 312 struct dpdmux_l2_rule {
 313         uint8_t mac_addr[6];
 314         uint16_t vlan_id;
 315 };
 316
 317 int dpdmux_if_remove_l2_rule(struct fsl_mc_io *mc_io,
 318                              uint32_t cmd_flags,
 319                              uint16_t token,
 320                              uint16_t if_id,
 321                              const struct dpdmux_l2_rule *rule);
 322
 323 int dpdmux_if_add_l2_rule(struct fsl_mc_io *mc_io,
 324                           uint32_t cmd_flags,
 325                           uint16_t token,
 326                           uint16_t if_id,
 327                           const struct dpdmux_l2_rule *rule);
 328
 329 int dpdmux_if_get_counter(struct fsl_mc_io *mc_io,
 330                           uint32_t cmd_flags,
 331                           uint16_t token,
 332                           uint16_t if_id,
 333                           enum dpdmux_counter_type counter_type,
 334                           uint64_t *counter);
 335
 336 int dpdmux_ul_reset_counters(struct fsl_mc_io *mc_io,
 337                              uint32_t cmd_flags,
 338                              uint16_t token);
 339
 340 /**
 341  * Enable auto-negotiation
 342  */
 343 #define DPDMUX_LINK_OPT_AUTONEG         0x0000000000000001ULL
 344 /**
 345  * Enable half-duplex mode
 346  */
 347 #define DPDMUX_LINK_OPT_HALF_DUPLEX     0x0000000000000002ULL
 348 /**
 349  * Enable pause frames
 350  */
 351 #define DPDMUX_LINK_OPT_PAUSE           0x0000000000000004ULL
 352 /**
 353  * Enable a-symmetric pause frames
 354  */
 355 #define DPDMUX_LINK_OPT_ASYM_PAUSE      0x0000000000000008ULL
 356
 357 /**
 358  * struct dpdmux_link_cfg - Structure representing DPDMUX link configuration
 359  * @rate: Rate
 360  * @options: Mask of available options; use 'DPDMUX_LINK_OPT_<X>' values
 361  */
 362 struct dpdmux_link_cfg {
 363         uint32_t rate;
 364         uint64_t options;
 365         uint64_t advertising;
 366 };
 367
 368 int dpdmux_if_set_link_cfg(struct fsl_mc_io *mc_io,
 369                            uint32_t cmd_flags,
 370                            uint16_t token,
 371                            uint16_t if_id,
 372                            struct dpdmux_link_cfg *cfg);
 373 /**
 374  * struct dpdmux_link_state - Structure representing DPDMUX link state
 375  * @rate: Rate
 376  * @options: Mask of available options; use 'DPDMUX_LINK_OPT_<X>' values
 377  * @up: 0 - down, 1 - up
 378  * @state_valid: Ignore/Update the state of the link
 379  * @supported: Speeds capability of the phy (bitmap)
 380  * @advertising: Speeds that are advertised for autoneg (bitmap)
 381  */
 382 struct dpdmux_link_state {
 383         uint32_t rate;
 384         uint64_t options;
 385         int      up;
 386         int      state_valid;
 387         uint64_t supported;
 388         uint64_t advertising;
 389 };
 390
 391 int dpdmux_if_get_link_state(struct fsl_mc_io *mc_io,
 392                              uint32_t cmd_flags,
 393                              uint16_t token,
 394                              uint16_t if_id,
 395                              struct dpdmux_link_state *state);
 396
 397 int dpdmux_if_set_default(struct fsl_mc_io *mc_io,
 398                 uint32_t cmd_flags,
 399                 uint16_t token,
 400                 uint16_t if_id);
 401
 402 int dpdmux_if_get_default(struct fsl_mc_io *mc_io,
 403                 uint32_t cmd_flags,
 404                 uint16_t token,
 405                 uint16_t *if_id);
 406
 407 int dpdmux_set_custom_key(struct fsl_mc_io *mc_io,
 408                         uint32_t cmd_flags,
 409                         uint16_t token,
 410                         uint64_t key_cfg_iova);
 411
 412 /**
 413  * struct dpdmux_rule_cfg - Custom classification rule.
 414  *
 415  * @key_iova: DMA address of buffer storing the look-up value
 416  * @mask_iova: DMA address of the mask used for TCAM classification. This
 417  *  parameter is used only if dpdmux was created using option
 418  *  DPDMUX_OPT_CLS_MASK_SUPPORT.
 419  * @key_size: size, in bytes, of the look-up value. This must match the size
 420  *      of the look-up key defined using dpdmux_set_custom_key, otherwise the
 421  *      entry will never be hit
 422  * @entry_index: rule index into the table. This parameter is used only when
 423  *  dpdmux object was created using option DPDMUX_OPT_CLS_MASK_SUPPORT. In
 424  *  this case the rule is masking and the current frame may be a hit for
 425  *  multiple rules. This parameter determines the order in which the rules
 426  *  will be checked (smaller entry_index first).
 427  */
 428 struct dpdmux_rule_cfg {
 429         uint64_t key_iova;
 430         uint64_t mask_iova;
 431         uint8_t key_size;
 432         uint16_t entry_index;
 433 };
 434
 435 /**
 436  * struct dpdmux_cls_action - Action to execute for frames matching the
 437  *      classification entry
 438  *
 439  * @dest_if: Interface to forward the frames to. Port numbering is similar to
 440  *      the one used to connect interfaces:
 441  *      - 0 is the uplink port,
 442  *      - all others are downlink ports.
 443  */
 444 struct dpdmux_cls_action {
 445         uint16_t dest_if;
 446 };
 447
 448 int dpdmux_add_custom_cls_entry(struct fsl_mc_io *mc_io,
 449                 uint32_t cmd_flags,
 450                 uint16_t token,
 451                 struct dpdmux_rule_cfg *rule,
 452                 struct dpdmux_cls_action *action);
 453
 454 int dpdmux_remove_custom_cls_entry(struct fsl_mc_io *mc_io,
 455                 uint32_t cmd_flags,
 456                 uint16_t token,
 457                 struct dpdmux_rule_cfg *rule);
 458
 459 int dpdmux_get_api_version(struct fsl_mc_io *mc_io,
 460                            uint32_t cmd_flags,
 461                            uint16_t *major_ver,
 462                            uint16_t *minor_ver);
 463
 464 /**
 465  * Discard bit. This bit must be used together with other bits in
 466  * DPDMUX_ERROR_ACTION_CONTINUE to disable discarding of frames containing
 467  * errors
 468  */
 469 #define DPDMUX_ERROR_DISC               0x80000000
 470 /**
 471  * MACSEC is enabled
 472  */
 473 #define DPDMUX_ERROR_MS                 0x40000000
 474 /**
 475  * PTP event frame
 476  */
 477 #define DPDMUX_ERROR_PTP                        0x08000000
 478 /**
 479  * This is a multicast frame
 480  */
 481 #define DPDMUX_ERROR_MC                 0x04000000
 482 /**
 483  * This is a broadcast frame
 484  */
 485 #define DPDMUX_ERROR_BC                 0x02000000
 486 /**
 487  * Invalid Key composition or key size error
 488  */
 489 #define DPDMUX_ERROR_KSE                        0x00040000
 490 /**
 491  * Extract out of frame header
 492  */
 493 #define DPDMUX_ERROR_EOFHE              0x00020000
 494 /**
 495  * Maximum number of chained lookups is reached
 496  */
 497 #define DPDMUX_ERROR_MNLE                       0x00010000
 498 /**
 499  * Invalid table ID
 500  */
 501 #define DPDMUX_ERROR_TIDE                       0x00008000
 502 /**
 503  * Policer initialization entry error
 504  */
 505 #define DPDMUX_ERROR_PIEE                       0x00004000
 506 /**
 507  * Frame length error
 508  */
 509 #define DPDMUX_ERROR_FLE                        0x00002000
 510 /**
 511  * Frame physical error
 512  */
 513 #define DPDMUX_ERROR_FPE                        0x00001000
 514 /**
 515  * Cycle limit is exceeded and frame parsing is forced to terminate early
 516  */
 517 #define DPDMUX_ERROR_PTE                        0x00000080
 518 /**
 519  * Invalid softparse instruction is encountered
 520  */
 521 #define DPDMUX_ERROR_ISP                        0x00000040
 522 /**
 523  * Parsing header error
 524  */
 525 #define DPDMUX_ERROR_PHE                        0x00000020
 526 /*
 527  * Block limit is exceeded. Maximum data that can be read and parsed is 256
 528  * bytes.
 529  * Parser will set this bit if it needs more that this limit to parse.
 530  */
 531 #define DPDMUX_ERROR_BLE                        0x00000010
 532 /**
 533  * L3 checksum validation
 534  */
 535 #define DPDMUX__ERROR_L3CV                      0x00000008
 536 /**
 537  * L3 checksum error
 538  */
 539 #define DPDMUX__ERROR_L3CE                      0x00000004
 540 /**
 541  * L4 checksum validation
 542  */
 543 #define DPDMUX__ERROR_L4CV                      0x00000002
 544 /**
 545  * L4 checksum error
 546  */
 547 #define DPDMUX__ERROR_L4CE                      0x00000001
 548
 549 enum dpdmux_error_action {
 550         DPDMUX_ERROR_ACTION_DISCARD = 0,
 551         DPDMUX_ERROR_ACTION_CONTINUE = 1
 552 };
 553
 554 /**
 555  * Configure how dpdmux interface behaves on errors
 556  * @errors - or'ed combination of DPDMUX_ERROR_*
 557  * @action - set to DPDMUX_ERROR_ACTION_DISCARD or DPDMUX_ERROR_ACTION_CONTINUE
 558  */
 559 struct dpdmux_error_cfg {
 560         uint32_t errors;
 561         enum dpdmux_error_action error_action;
 562 };
 563
 564 int dpdmux_if_set_errors_behavior(struct fsl_mc_io *mc_io, uint32_t cmd_flags,
 565                 uint16_t token, uint16_t if_id, struct dpdmux_error_cfg *cfg);
 566
 567 #endif /* __FSL_DPDMUX_H */