public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Dong, Eric" <eric.dong@intel.com>
To: "devel@edk2.groups.io" <devel@edk2.groups.io>,
	"lersek@redhat.com" <lersek@redhat.com>
Cc: "Ni, Ray" <ray.ni@intel.com>
Subject: Re: [edk2-devel] [Patch 1/4] UefiCpuPkg/RegisterCpuFeaturesLib: Add "detect before set" Micros.
Date: Mon, 12 Aug 2019 07:46:12 +0000	[thread overview]
Message-ID: <ED077930C258884BBCB450DB737E662259EC0CAC@shsmsx102.ccr.corp.intel.com> (raw)
In-Reply-To: <a16a1d99-268d-deac-6f93-2bfa71497ad7@redhat.com>

Hi Laszlo,

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of
> Laszlo Ersek
> Sent: Friday, August 9, 2019 11:14 PM
> To: Dong, Eric <eric.dong@intel.com>; devel@edk2.groups.io
> Cc: Ni, Ray <ray.ni@intel.com>
> Subject: Re: [edk2-devel] [Patch 1/4] UefiCpuPkg/RegisterCpuFeaturesLib:
> Add "detect before set" Micros.
> 
> On 08/09/19 08:11, Eric Dong wrote:
> > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=2040
> >
> > Add below new micros which test the current value before set the new
> > value. Only set new value when current value not same as new value.
> >   CPU_REGISTER_TABLE_TEST_THEN_WRITE32
> >   CPU_REGISTER_TABLE_TEST_THEN_WRITE64
> >   CPU_REGISTER_TABLE_TEST_THEN_WRITE_FIELD
> >
> > Signed-off-by: Eric Dong <eric.dong@intel.com>
> > Cc: Ray Ni <ray.ni@intel.com>
> > Cc: Laszlo Ersek <lersek@redhat.com>
> > ---
> >  UefiCpuPkg/Include/AcpiCpuData.h              |  1 +
> >  .../Include/Library/RegisterCpuFeaturesLib.h  | 77 +++++++++++++++++--
> >  .../RegisterCpuFeaturesLib.c                  | 14 +++-
> >  3 files changed, 80 insertions(+), 12 deletions(-)
> 
> (1) When you format your patch sets, can you please use the following two
> options:
> 
>  --stat=1000 --stat-graph-width=20
> 
> Otherwise the diffstats are truncated (on the left) and hard to understand.
> 

1. I use TortoiseGit to create patch, do you know how to enable these setting in TortoiseGit?
 
> >
> > diff --git a/UefiCpuPkg/Include/AcpiCpuData.h
> > b/UefiCpuPkg/Include/AcpiCpuData.h
> > index b963a2f592..c764e209cf 100644
> > --- a/UefiCpuPkg/Include/AcpiCpuData.h
> > +++ b/UefiCpuPkg/Include/AcpiCpuData.h
> > @@ -81,6 +81,7 @@ typedef struct {
> >    UINT16         Reserved;              // offset 10 - 11
> >    UINT32         HighIndex;             // offset 12-15, only valid for
> MemoryMapped
> >    UINT64         Value;                 // offset 16-23
> > +  UINT8          DetectIt;              // 0ffset 24
> >  } CPU_REGISTER_TABLE_ENTRY;
> 
> (2) Another quite generic comment -- "DetectIt" does not look helpful.
> Somehow the verb "detect" does not communicate the right action to me.
> 
> How about using a more established name, such as:
> 
> - CompareAndSwap
> - CompareAndSet
> - TestAndSet
> 
> ?
> 
> If you agree, then I suggest updating the parameter names, and their
> comments too, below.

2.  Yes, I change from "TestIt" to "DetectIt" because I think it's better. Seems like this is not a correct change. 
I will use "TestThenWrite" as the new name which align our new macro " CPU_REGISTER_TABLE_TEST_THEN_WRITE****". What do you think?

Thanks,
Eric

> 
> Thanks
> Laszlo
> 
> 
> >
> >  //
> > diff --git a/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
> > b/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
> > index e420e7f075..87fe87acb7 100644
> > --- a/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
> > +++ b/UefiCpuPkg/Include/Library/RegisterCpuFeaturesLib.h
> > @@ -335,6 +335,7 @@ SwitchBspAfterFeaturesInitialize (
> >    @param[in]  Index            Index of the register to program
> >    @param[in]  ValueMask        Mask of bits in register to write
> >    @param[in]  Value            Value to write
> > +  @param[in]  DetectIt         Whether need to detect current Value before
> writing.
> >
> >    @note This service could be called by BSP only.
> >  **/
> > @@ -345,7 +346,8 @@ CpuRegisterTableWrite (
> >    IN REGISTER_TYPE       RegisterType,
> >    IN UINT64              Index,
> >    IN UINT64              ValueMask,
> > -  IN UINT64              Value
> > +  IN UINT64              Value,
> > +  IN UINT8               DetectIt
> >    );
> >
> >  /**
> > @@ -385,9 +387,45 @@ PreSmmCpuRegisterTableWrite (
> >
> >    @note This service could be called by BSP only.
> >  **/
> > -#define CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType,
> Index, Value)       \
> > -  do {                                                                                \
> > -    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> MAX_UINT32, Value);  \
> > +#define CPU_REGISTER_TABLE_WRITE32(ProcessorNumber,
> RegisterType, Index, Value)              \
> > +  do {                                                                                       \
> > +    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> > +MAX_UINT32, Value, FALSE);  \
> > +  } while(FALSE);
> > +
> > +/**
> > +  Adds a 32-bit register write entry in specified register table.
> > +
> > +  This macro adds an entry in specified register table, with given
> > + register type,  register index, and value.
> > +
> > +  @param[in]  ProcessorNumber  The index of the CPU to add a register
> table entry.
> > +  @param[in]  RegisterType     Type of the register to program
> > +  @param[in]  Index            Index of the register to program
> > +  @param[in]  Value            Value to write
> > +
> > +  @note This service could be called by BSP only.
> > +**/
> > +#define CPU_REGISTER_TABLE_TEST_THEN_WRITE32(ProcessorNumber,
> RegisterType, Index, Value)   \
> > +  do {                                                                                      \
> > +    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> > +MAX_UINT32, Value, TRUE);  \
> > +  } while(FALSE);
> > +
> > +/**
> > +  Adds a 64-bit register write entry in specified register table.
> > +
> > +  This macro adds an entry in specified register table, with given
> > + register type,  register index, and value.
> > +
> > +  @param[in]  ProcessorNumber  The index of the CPU to add a register
> table entry.
> > +  @param[in]  RegisterType     Type of the register to program
> > +  @param[in]  Index            Index of the register to program
> > +  @param[in]  Value            Value to write
> > +
> > +  @note This service could be called by BSP only.
> > +**/
> > +#define CPU_REGISTER_TABLE_WRITE64(ProcessorNumber,
> RegisterType, Index, Value)              \
> > +  do {                                                                                       \
> > +    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> > +MAX_UINT64, Value, FALSE);  \
> >    } while(FALSE);
> >
> >  /**
> > @@ -403,9 +441,9 @@ PreSmmCpuRegisterTableWrite (
> >
> >    @note This service could be called by BSP only.
> >  **/
> > -#define CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType,
> Index, Value)       \
> > -  do {                                                                                \
> > -    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> MAX_UINT64, Value);  \
> > +#define CPU_REGISTER_TABLE_TEST_THEN_WRITE64(ProcessorNumber,
> RegisterType, Index, Value)   \
> > +  do {                                                                                      \
> > +    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> > +MAX_UINT64, Value, TRUE);  \
> >    } while(FALSE);
> >
> >  /**
> > @@ -428,7 +466,30 @@ PreSmmCpuRegisterTableWrite (
> >      UINT64  ValueMask;                                                                           \
> >      ValueMask = MAX_UINT64;                                                                      \
> >      ((Type *)(&ValueMask))->Field = 0;                                                           \
> > -    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> ~ValueMask, Value);             \
> > +    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> ~ValueMask, Value, FALSE);      \
> > +  } while(FALSE);
> > +
> > +/**
> > +  Adds a bit field write entry in specified register table.
> > +
> > +  This macro adds an entry in specified register table, with given
> > + register type,  register index, bit field section, and value.
> > +
> > +  @param[in]  ProcessorNumber  The index of the CPU to add a register
> table entry.
> > +  @param[in]  RegisterType     Type of the register to program.
> > +  @param[in]  Index            Index of the register to program.
> > +  @param[in]  Type             The data type name of a register structure.
> > +  @param[in]  Field            The bit fiel name in register structure to write.
> > +  @param[in]  Value            Value to write to the bit field.
> > +
> > +  @note This service could be called by BSP only.
> > +**/
> > +#define
> CPU_REGISTER_TABLE_TEST_THEN_WRITE_FIELD(ProcessorNumber,
> RegisterType, Index, Type, Field, Value) \
> > +  do {                                                                                                     \
> > +    UINT64  ValueMask;                                                                                     \
> > +    ValueMask = MAX_UINT64;                                                                                \
> > +    ((Type *)(&ValueMask))->Field = 0;                                                                     \
> > +    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index,
> ~ValueMask, Value, TRUE);                 \
> >    } while(FALSE);
> >
> >  /**
> > diff --git
> > a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
> > b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
> > index 67885bf69b..152ab75988 100644
> > ---
> > a/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib.c
> > +++
> b/UefiCpuPkg/Library/RegisterCpuFeaturesLib/RegisterCpuFeaturesLib
> > +++ .c
> > @@ -1025,6 +1025,8 @@ EnlargeRegisterTable (
> >    @param[in]  ValidBitStart    Start of the bit section
> >    @param[in]  ValidBitLength   Length of the bit section
> >    @param[in]  Value            Value to write
> > +  @param[in]  DetectIt         Whether need to detect current Value before
> writing.
> > +
> >  **/
> >  VOID
> >  CpuRegisterTableWriteWorker (
> > @@ -1034,7 +1036,8 @@ CpuRegisterTableWriteWorker (
> >    IN UINT64                  Index,
> >    IN UINT8                   ValidBitStart,
> >    IN UINT8                   ValidBitLength,
> > -  IN UINT64                  Value
> > +  IN UINT64                  Value,
> > +  IN UINT8                   DetectIt
> >    )
> >  {
> >    CPU_FEATURES_DATA        *CpuFeaturesData;
> > @@ -1070,6 +1073,7 @@ CpuRegisterTableWriteWorker (
> >    RegisterTableEntry[RegisterTable->TableLength].ValidBitStart  =
> ValidBitStart;
> >    RegisterTableEntry[RegisterTable->TableLength].ValidBitLength =
> ValidBitLength;
> >    RegisterTableEntry[RegisterTable->TableLength].Value          = Value;
> > +  RegisterTableEntry[RegisterTable->TableLength].DetectIt       = DetectIt;
> >
> >    RegisterTable->TableLength++;
> >  }
> > @@ -1085,6 +1089,7 @@ CpuRegisterTableWriteWorker (
> >    @param[in]  Index            Index of the register to program
> >    @param[in]  ValueMask        Mask of bits in register to write
> >    @param[in]  Value            Value to write
> > +  @param[in]  DetectIt         Whether need to detect current Value before
> writing.
> >
> >    @note This service could be called by BSP only.
> >  **/
> > @@ -1095,7 +1100,8 @@ CpuRegisterTableWrite (
> >    IN REGISTER_TYPE       RegisterType,
> >    IN UINT64              Index,
> >    IN UINT64              ValueMask,
> > -  IN UINT64              Value
> > +  IN UINT64              Value,
> > +  IN UINT8               DetectIt
> >    )
> >  {
> >    UINT8                   Start;
> > @@ -1105,7 +1111,7 @@ CpuRegisterTableWrite (
> >    Start  = (UINT8)LowBitSet64  (ValueMask);
> >    End    = (UINT8)HighBitSet64 (ValueMask);
> >    Length = End - Start + 1;
> > -  CpuRegisterTableWriteWorker (FALSE, ProcessorNumber, RegisterType,
> > Index, Start, Length, Value);
> > +  CpuRegisterTableWriteWorker (FALSE, ProcessorNumber, RegisterType,
> > + Index, Start, Length, Value, DetectIt);
> >  }
> >
> >  /**
> > @@ -1139,7 +1145,7 @@ PreSmmCpuRegisterTableWrite (
> >    Start  = (UINT8)LowBitSet64  (ValueMask);
> >    End    = (UINT8)HighBitSet64 (ValueMask);
> >    Length = End - Start + 1;
> > -  CpuRegisterTableWriteWorker (TRUE, ProcessorNumber, RegisterType,
> > Index, Start, Length, Value);
> > +  CpuRegisterTableWriteWorker (TRUE, ProcessorNumber, RegisterType,
> > + Index, Start, Length, Value, FALSE);
> >  }
> >
> >  /**
> >
> 
> 
> 


  reply	other threads:[~2019-08-12  7:46 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-09  6:11 [Patch 0/4] Add "Test then Set" mechanism Dong, Eric
2019-08-09  6:11 ` [Patch 1/4] UefiCpuPkg/RegisterCpuFeaturesLib: Add "detect before set" Micros Dong, Eric
2019-08-09 15:14   ` Laszlo Ersek
2019-08-12  7:46     ` Dong, Eric [this message]
2019-08-12 13:01       ` [edk2-devel] " Laszlo Ersek
2019-08-09 15:31   ` Laszlo Ersek
2019-08-12  8:05     ` Dong, Eric
2019-08-09  6:11 ` [Patch 2/4] UefiCpuPkg/RegisterCpuFeaturesLib: Supports detect before set new value logic Dong, Eric
2019-08-09  6:11 ` [Patch 3/4] UefiCpuPkg/PiSmmCpuDxeSmm: " Dong, Eric
2019-08-09 15:30   ` Laszlo Ersek
2019-08-12  8:37     ` [edk2-devel] " Dong, Eric
2019-08-09  6:11 ` [Patch 4/4] UefiCpuPkg/CpuCommonFeaturesLib: Use "Test then set" action Dong, Eric

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ED077930C258884BBCB450DB737E662259EC0CAC@shsmsx102.ccr.corp.intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox