ACPI: CPPC: Amend documentation in the comments
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Wed, 22 Dec 2021 14:04:45 +0000 (16:04 +0200)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Wed, 22 Dec 2021 17:31:41 +0000 (18:31 +0100)
Currently it's too hard to read the _CPC structure as it's commented.
Reshuffle indentation and style to make it readable.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
drivers/acpi/cppc_acpi.c

index b62c87b8ce4a99650c0ed3140ac449ce45238d10..182471f319feb01a9895ad5476039abb80c32fb0 100644 (file)
@@ -604,47 +604,30 @@ static bool is_cppc_supported(int revision, int num_ent)
 /*
  * An example CPC table looks like the following.
  *
- *     Name(_CPC, Package()
- *                     {
- *                     17,
- *                     NumEntries
- *                     1,
- *                     // Revision
- *                     ResourceTemplate(){Register(PCC, 32, 0, 0x120, 2)},
- *                     // Highest Performance
- *                     ResourceTemplate(){Register(PCC, 32, 0, 0x124, 2)},
- *                     // Nominal Performance
- *                     ResourceTemplate(){Register(PCC, 32, 0, 0x128, 2)},
- *                     // Lowest Nonlinear Performance
- *                     ResourceTemplate(){Register(PCC, 32, 0, 0x12C, 2)},
- *                     // Lowest Performance
- *                     ResourceTemplate(){Register(PCC, 32, 0, 0x130, 2)},
- *                     // Guaranteed Performance Register
- *                     ResourceTemplate(){Register(PCC, 32, 0, 0x110, 2)},
- *                     // Desired Performance Register
- *                     ResourceTemplate(){Register(SystemMemory, 0, 0, 0, 0)},
- *                     ..
- *                     ..
- *                     ..
- *
- *             }
+ *  Name (_CPC, Package() {
+ *      17,                                                    // NumEntries
+ *      1,                                                     // Revision
+ *      ResourceTemplate() {Register(PCC, 32, 0, 0x120, 2)},   // Highest Performance
+ *      ResourceTemplate() {Register(PCC, 32, 0, 0x124, 2)},   // Nominal Performance
+ *      ResourceTemplate() {Register(PCC, 32, 0, 0x128, 2)},   // Lowest Nonlinear Performance
+ *      ResourceTemplate() {Register(PCC, 32, 0, 0x12C, 2)},   // Lowest Performance
+ *      ResourceTemplate() {Register(PCC, 32, 0, 0x130, 2)},   // Guaranteed Performance Register
+ *      ResourceTemplate() {Register(PCC, 32, 0, 0x110, 2)},   // Desired Performance Register
+ *      ResourceTemplate() {Register(SystemMemory, 0, 0, 0, 0)},
+ *      ...
+ *      ...
+ *      ...
+ *  }
  * Each Register() encodes how to access that specific register.
  * e.g. a sample PCC entry has the following encoding:
  *
- *     Register (
- *             PCC,
- *             AddressSpaceKeyword
- *             8,
- *             //RegisterBitWidth
- *             8,
- *             //RegisterBitOffset
- *             0x30,
- *             //RegisterAddress
- *             9
- *             //AccessSize (subspace ID)
- *             0
- *             )
- *     }
+ *  Register (
+ *      PCC,   // AddressSpaceKeyword
+ *      8,     // RegisterBitWidth
+ *      8,     // RegisterBitOffset
+ *      0x30,  // RegisterAddress
+ *      9,     // AccessSize (subspace ID)
+ *  )
  */
 
 #ifndef init_freq_invariance_cppc