Skip to content

Commit b134b10

Browse files
Alex Elderdavem330
authored andcommitted
net: ipa: update IPA version comments in "ipa_reg.h"
Some definitions in "ipa_reg.h" are only valid for certain versions of IPA. In such cases a comment indicates a version or range of versions where the definition is (or is not) valid. Almost all such cases look like "IPA vX.Y", but a few don't include the "IPA" tag. Update these so they all consistently include "IPA". And replace a few lines that talk about "the next bit" in the definition of the ipa_irq_id enumerated type with a more concise comment using the "IPA vX.Y" convention. Signed-off-by: Alex Elder <elder@linaro.org> Signed-off-by: David S. Miller <davem@davemloft.net>
1 parent dd043b3 commit b134b10

File tree

1 file changed

+41
-45
lines changed

1 file changed

+41
-45
lines changed

drivers/net/ipa/ipa_reg.h

Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -240,25 +240,25 @@ enum ipa_reg_local_pkt_proc_cntxt_field_id {
240240

241241
/* COUNTER_CFG register */
242242
enum ipa_reg_counter_cfg_field_id {
243-
EOT_COAL_GRANULARITY, /* Not v3.5+ */
243+
EOT_COAL_GRANULARITY, /* Not IPA v3.5+ */
244244
AGGR_GRANULARITY,
245245
};
246246

247247
/* IPA_TX_CFG register */
248248
enum ipa_reg_ipa_tx_cfg_field_id {
249-
TX0_PREFETCH_DISABLE, /* Not v4.0+ */
250-
TX1_PREFETCH_DISABLE, /* Not v4.0+ */
251-
PREFETCH_ALMOST_EMPTY_SIZE, /* Not v4.0+ */
252-
PREFETCH_ALMOST_EMPTY_SIZE_TX0, /* v4.0+ */
253-
DMAW_SCND_OUTSD_PRED_THRESHOLD, /* v4.0+ */
254-
DMAW_SCND_OUTSD_PRED_EN, /* v4.0+ */
255-
DMAW_MAX_BEATS_256_DIS, /* v4.0+ */
256-
PA_MASK_EN, /* v4.0+ */
257-
PREFETCH_ALMOST_EMPTY_SIZE_TX1, /* v4.0+ */
258-
DUAL_TX_ENABLE, /* v4.5+ */
259-
SSPND_PA_NO_START_STATE, /* v4,2+, not v4.5 */
260-
SSPND_PA_NO_BQ_STATE, /* v4.2 only */
261-
HOLB_STICKY_DROP_EN, /* v5.0+ */
249+
TX0_PREFETCH_DISABLE, /* Not IPA v4.0+ */
250+
TX1_PREFETCH_DISABLE, /* Not IPA v4.0+ */
251+
PREFETCH_ALMOST_EMPTY_SIZE, /* Not IPA v4.0+ */
252+
PREFETCH_ALMOST_EMPTY_SIZE_TX0, /* IPA v4.0+ */
253+
DMAW_SCND_OUTSD_PRED_THRESHOLD, /* IPA v4.0+ */
254+
DMAW_SCND_OUTSD_PRED_EN, /* IPA v4.0+ */
255+
DMAW_MAX_BEATS_256_DIS, /* IPA v4.0+ */
256+
PA_MASK_EN, /* IPA v4.0+ */
257+
PREFETCH_ALMOST_EMPTY_SIZE_TX1, /* IPA v4.0+ */
258+
DUAL_TX_ENABLE, /* IPA v4.5+ */
259+
SSPND_PA_NO_START_STATE, /* IPA v4,2+, not IPA v4.5 */
260+
SSPND_PA_NO_BQ_STATE, /* IPA v4.2 only */
261+
HOLB_STICKY_DROP_EN, /* IPA v5.0+ */
262262
};
263263

264264
/* FLAVOR_0 register */
@@ -319,8 +319,8 @@ enum ipa_reg_rsrc_grp_rsrc_type_field_id {
319319

320320
/* ENDP_INIT_CTRL register */
321321
enum ipa_reg_endp_init_ctrl_field_id {
322-
ENDP_SUSPEND, /* Not v4.0+ */
323-
ENDP_DELAY, /* Not v4.2+ */
322+
ENDP_SUSPEND, /* Not IPA v4.0+ */
323+
ENDP_DELAY, /* Not IPA v4.2+ */
324324
};
325325

326326
/* ENDP_INIT_CFG register */
@@ -359,11 +359,11 @@ enum ipa_reg_endp_init_hdr_field_id {
359359
HDR_ADDITIONAL_CONST_LEN,
360360
HDR_OFST_PKT_SIZE_VALID,
361361
HDR_OFST_PKT_SIZE,
362-
HDR_A5_MUX, /* Not v4.9+ */
362+
HDR_A5_MUX, /* Not IPA v4.9+ */
363363
HDR_LEN_INC_DEAGG_HDR,
364-
HDR_METADATA_REG_VALID, /* Not v4.5+ */
365-
HDR_LEN_MSB, /* v4.5+ */
366-
HDR_OFST_METADATA_MSB, /* v4.5+ */
364+
HDR_METADATA_REG_VALID, /* Not IPA v4.5+ */
365+
HDR_LEN_MSB, /* IPA v4.5+ */
366+
HDR_OFST_METADATA_MSB, /* IPA v4.5+ */
367367
};
368368

369369
/* ENDP_INIT_HDR_EXT register */
@@ -374,23 +374,23 @@ enum ipa_reg_endp_init_hdr_ext_field_id {
374374
HDR_PAYLOAD_LEN_INC_PADDING,
375375
HDR_TOTAL_LEN_OR_PAD_OFFSET,
376376
HDR_PAD_TO_ALIGNMENT,
377-
HDR_TOTAL_LEN_OR_PAD_OFFSET_MSB, /* v4.5+ */
378-
HDR_OFST_PKT_SIZE_MSB, /* v4.5+ */
379-
HDR_ADDITIONAL_CONST_LEN_MSB, /* v4.5+ */
380-
HDR_BYTES_TO_REMOVE_VALID, /* v5.0+ */
381-
HDR_BYTES_TO_REMOVE, /* v5.0+ */
377+
HDR_TOTAL_LEN_OR_PAD_OFFSET_MSB, /* IPA v4.5+ */
378+
HDR_OFST_PKT_SIZE_MSB, /* IPA v4.5+ */
379+
HDR_ADDITIONAL_CONST_LEN_MSB, /* IPA v4.5+ */
380+
HDR_BYTES_TO_REMOVE_VALID, /* IPA v5.0+ */
381+
HDR_BYTES_TO_REMOVE, /* IPA v5.0+ */
382382
};
383383

384384
/* ENDP_INIT_MODE register */
385385
enum ipa_reg_endp_init_mode_field_id {
386386
ENDP_MODE,
387-
DCPH_ENABLE, /* v4.5+ */
387+
DCPH_ENABLE, /* IPA v4.5+ */
388388
DEST_PIPE_INDEX,
389389
BYTE_THRESHOLD,
390390
PIPE_REPLICATION_EN,
391391
PAD_EN,
392-
HDR_FTCH_DISABLE, /* v4.5+ */
393-
DRBIP_ACL_ENABLE, /* v4.9+ */
392+
HDR_FTCH_DISABLE, /* IPA v4.5+ */
393+
DRBIP_ACL_ENABLE, /* IPA v4.9+ */
394394
};
395395

396396
/** enum ipa_mode - ENDP_INIT_MODE register MODE field value */
@@ -439,10 +439,10 @@ enum ipa_reg_endp_init_hol_block_en_field_id {
439439

440440
/* ENDP_INIT_HOL_BLOCK_TIMER register */
441441
enum ipa_reg_endp_init_hol_block_timer_field_id {
442-
TIMER_BASE_VALUE, /* Not v4.5+ */
443-
TIMER_SCALE, /* v4.2 only */
444-
TIMER_LIMIT, /* v4.5+ */
445-
TIMER_GRAN_SEL, /* v4.5+ */
442+
TIMER_BASE_VALUE, /* Not IPA v4.5+ */
443+
TIMER_SCALE, /* IPA v4.2 only */
444+
TIMER_LIMIT, /* IPA v4.5+ */
445+
TIMER_GRAN_SEL, /* IPA v4.5+ */
446446
};
447447

448448
/* ENDP_INIT_DEAGGR register */
@@ -463,7 +463,7 @@ enum ipa_reg_endp_init_rsrc_grp_field_id {
463463
/* ENDP_INIT_SEQ register */
464464
enum ipa_reg_endp_init_seq_field_id {
465465
SEQ_TYPE,
466-
SEQ_REP_TYPE, /* Not v4.5+ */
466+
SEQ_REP_TYPE, /* Not IPA v4.5+ */
467467
};
468468

469469
/**
@@ -512,8 +512,8 @@ enum ipa_seq_rep_type {
512512
enum ipa_reg_endp_status_field_id {
513513
STATUS_EN,
514514
STATUS_ENDP,
515-
STATUS_LOCATION, /* Not v4.5+ */
516-
STATUS_PKT_SUPPRESS, /* v4.0+ */
515+
STATUS_LOCATION, /* Not IPA v4.5+ */
516+
STATUS_PKT_SUPPRESS, /* IPA v4.0+ */
517517
};
518518

519519
/* ENDP_FILTER_ROUTER_HSH_CFG register */
@@ -588,8 +588,7 @@ enum ipa_reg_endp_cache_cfg_field_id {
588588
*/
589589
enum ipa_irq_id {
590590
IPA_IRQ_BAD_SNOC_ACCESS = 0x0,
591-
/* The next bit is not present for IPA v3.5+ */
592-
IPA_IRQ_EOT_COAL = 0x1,
591+
IPA_IRQ_EOT_COAL = 0x1, /* Not IPA v3.5+ */
593592
IPA_IRQ_UC_0 = 0x2,
594593
IPA_IRQ_UC_1 = 0x3,
595594
IPA_IRQ_UC_2 = 0x4,
@@ -610,17 +609,14 @@ enum ipa_irq_id {
610609
IPA_IRQ_PIPE_YELLOW_ABOVE = 0x13,
611610
IPA_IRQ_PIPE_RED_ABOVE = 0x14,
612611
IPA_IRQ_UCP = 0x15,
613-
/* The next bit is not present for IPA v4.5+ */
614-
IPA_IRQ_DCMP = 0x16,
612+
IPA_IRQ_DCMP = 0x16, /* Not IPA v4.5+ */
615613
IPA_IRQ_GSI_EE = 0x17,
616614
IPA_IRQ_GSI_IPA_IF_TLV_RCVD = 0x18,
617615
IPA_IRQ_GSI_UC = 0x19,
618-
/* The next bit is present for IPA v4.5+ */
619-
IPA_IRQ_TLV_LEN_MIN_DSM = 0x1a,
620-
/* The next three bits are present for IPA v4.9+ */
621-
IPA_IRQ_DRBIP_PKT_EXCEED_MAX_SIZE_EN = 0x1b,
622-
IPA_IRQ_DRBIP_DATA_SCTR_CFG_ERROR_EN = 0x1c,
623-
IPA_IRQ_DRBIP_IMM_CMD_NO_FLSH_HZRD_EN = 0x1d,
616+
IPA_IRQ_TLV_LEN_MIN_DSM = 0x1a, /* IPA v4.5+ */
617+
IPA_IRQ_DRBIP_PKT_EXCEED_MAX_SIZE_EN = 0x1b, /* IPA v4.9+ */
618+
IPA_IRQ_DRBIP_DATA_SCTR_CFG_ERROR_EN = 0x1c, /* IPA v4.9+ */
619+
IPA_IRQ_DRBIP_IMM_CMD_NO_FLSH_HZRD_EN = 0x1d, /* IPA v4.9+ */
624620
IPA_IRQ_COUNT, /* Last; not an id */
625621
};
626622

0 commit comments

Comments
 (0)