diff mbox

[v4,02/26] ARM: pxa: magician: Change comments to be more informative

Message ID 5609ACBA.6080503@tul.cz (mailing list archive)
State New, archived
Headers show

Commit Message

Petr Cvek Sept. 28, 2015, 9:10 p.m. UTC 
This patch changes the comments in the HTC Magician machine source code
to better describe used devices and interfaces.

Signed-off-by: Petr Cvek <petr.cvek@tul.cz>
---
 arch/arm/mach-pxa/magician.c | 46 +++++++++++++++++++++++++++++---------------
 1 file changed, 31 insertions(+), 15 deletions(-)

Comments

Philipp Zabel Oct. 3, 2015, 12:19 p.m. UTC | #1 
Am Montag, den 28.09.2015, 23:10 +0200 schrieb Petr Cvek:
> This patch changes the comments in the HTC Magician machine source
> code
> to better describe used devices and interfaces.
> 
> Signed-off-by: Petr Cvek <petr.cvek@tul.cz>

This is mostly fine, some comments below.

[...]
>  static struct resource egpio_resources[] = {
> @@ -197,7 +199,10 @@ static struct htc_egpio_chip egpio_chips[] = {
>  		.gpio_base	= MAGICIAN_EGPIO(0, 0),
>  		.num_gpios	= 24,
>  		.direction	= HTC_EGPIO_OUTPUT,
> -		.initial_values	= 0x40, /*
> EGPIO_MAGICIAN_GSM_RESET */
> +		/*
> +		 * Depends on modules configuration
> +		 */
> +		.initial_values	= 0x40,
>  	},
>  	[1] = {
>  		.reg_start	= 4,

Why drop the info that this is the GSM reset while improving comments
in every other place with more information?

[...]
> +/*
> + * LCD PWM backlight (main)
> + *
> + * MP1521 frequency should be:
> + *	100-400 Hz = 2?.5*10^6 - 10?*10^6 ns

What is MP1521?

[...]
> @@ -459,7 +475,7 @@ static struct pasic3_leds_machinfo
> pasic3_leds_info = {
>  };
>  
>  /*
> - * PASIC3 with DS1WM
> + * PASIC3 DS1WM
>   */

This is indeed an mfd chip that contains a DS1WM IP core. I think the
older comment is better.

> @@ -492,7 +508,7 @@ static struct platform_device pasic3 = {
>  };
>  
>  /*
> - * USB "Transceiver"
> + * PXA UDC
>   */
>  
>  static struct resource gpio_vbus_resource = {

You fix this in a later commit, but here the change is incorrect.

regards
Philipp
Robert Jarzmik Oct. 13, 2015, 8:08 p.m. UTC | #2 
Philipp Zabel <philipp.zabel@gmail.com> writes:

> Am Montag, den 28.09.2015, 23:10 +0200 schrieb Petr Cvek:
>> This patch changes the comments in the HTC Magician machine source
>> code
>> to better describe used devices and interfaces.
>> 
>> Signed-off-by: Petr Cvek <petr.cvek@tul.cz>
Queued to pxa/for-next with Philipp's comments taken into account.

Thanks.

--
Robert

PS: the MP1521 topic
>> +/*
>> + * LCD PWM backlight (main)
>> + *
>> + * MP1521 frequency should be:
>> + *	100-400 Hz = 2?.5*10^6 - 10?*10^6 ns
>
> What is MP1521?
How about this one :
http://www.digchip.com/datasheets/parts/datasheet/1006/MP1521-pdf.php
diff mbox

Patch

diff --git a/arch/arm/mach-pxa/magician.c b/arch/arm/mach-pxa/magician.c
index c10f932..c8fa379 100644
--- a/arch/arm/mach-pxa/magician.c
+++ b/arch/arm/mach-pxa/magician.c
@@ -57,31 +57,31 @@  static unsigned long magician_pin_config[] __initdata = {
 	GPIO80_nCS_4,
 	GPIO33_nCS_5,
 
-	/* I2C */
+	/* I2C UDA1380 + OV9640 */
 	GPIO117_I2C_SCL,
 	GPIO118_I2C_SDA,
 
-	/* PWM 0 */
+	/* PWM 0 - LCD backlight */
 	GPIO16_PWM0_OUT,
 
-	/* I2S */
+	/* I2S UDA1380 capture */
 	GPIO28_I2S_BITCLK_OUT,
 	GPIO29_I2S_SDATA_IN,
 	GPIO31_I2S_SYNC,
 	GPIO113_I2S_SYSCLK,
 
-	/* SSP 1 */
+	/* SSP 1 UDA1380 playback */
 	GPIO23_SSP1_SCLK,
 	GPIO24_SSP1_SFRM,
 	GPIO25_SSP1_TXD,
 
-	/* SSP 2 */
+	/* SSP 2 TSC2046 touchscreen */
 	GPIO19_SSP2_SCLK,
 	GPIO14_SSP2_SFRM,
 	GPIO89_SSP2_TXD,
 	GPIO88_SSP2_RXD,
 
-	/* MMC */
+	/* MMC/SD/SDHC slot */
 	GPIO32_MMC_CLK,
 	GPIO92_MMC_DAT_0,
 	GPIO109_MMC_DAT_1,
@@ -92,7 +92,7 @@  static unsigned long magician_pin_config[] __initdata = {
 	/* LCD */
 	GPIOxx_LCD_TFT_16BPP,
 
-	/* QCI */
+	/* QCI camera interface */
 	GPIO12_CIF_DD_7,
 	GPIO17_CIF_DD_6,
 	GPIO50_CIF_DD_3,
@@ -120,7 +120,7 @@  static unsigned long magician_pin_config[] __initdata = {
 };
 
 /*
- * IRDA
+ * IrDA
  */
 
 static struct pxaficp_platform_data magician_ficp_info = {
@@ -175,7 +175,9 @@  static struct platform_device gpio_keys = {
 /*
  * EGPIO (Xilinx CPLD)
  *
- * 7 32-bit aligned 8-bit registers: 3x output, 1x irq, 3x input
+ * 32-bit aligned 8-bit registers
+ * 16 possible registers (reg windows size), only 7 used:
+ * 3x output, 1x irq, 3x input
  */
 
 static struct resource egpio_resources[] = {
@@ -197,7 +199,10 @@  static struct htc_egpio_chip egpio_chips[] = {
 		.gpio_base	= MAGICIAN_EGPIO(0, 0),
 		.num_gpios	= 24,
 		.direction	= HTC_EGPIO_OUTPUT,
-		.initial_values	= 0x40, /* EGPIO_MAGICIAN_GSM_RESET */
+		/*
+		 * Depends on modules configuration
+		 */
+		.initial_values	= 0x40,
 	},
 	[1] = {
 		.reg_start	= 4,
@@ -228,7 +233,7 @@  static struct platform_device egpio = {
 };
 
 /*
- * LCD - Toppoly TD028STEB1 or Samsung LTP280QV
+ * PXAFB LCD - Toppoly TD028STEB1 or Samsung LTP280QV
  */
 
 static struct pxafb_mode_info toppoly_modes[] = {
@@ -372,6 +377,13 @@  static void magician_backlight_exit(struct device *dev)
 	gpio_free_array(ARRAY_AND_SIZE(magician_bl_gpios));
 }
 
+/*
+ * LCD PWM backlight (main)
+ *
+ * MP1521 frequency should be:
+ *	100-400 Hz = 2?.5*10^6 - 10?*10^6 ns
+ */
+
 static struct platform_pwm_backlight_data backlight_data = {
 	.pwm_id		= 0,
 	.max_brightness	= 272,
@@ -393,7 +405,7 @@  static struct platform_device backlight = {
 };
 
 /*
- * LEDs
+ * GPIO LEDs, Phone keys backlight, vibra
  */
 
 static struct gpio_led gpio_leds[] = {
@@ -422,6 +434,10 @@  static struct platform_device leds_gpio = {
 	},
 };
 
+/*
+ * PASIC3 LEDs
+ */
+
 static struct pasic3_led pasic3_leds[] = {
 	{
 		.led = {
@@ -459,7 +475,7 @@  static struct pasic3_leds_machinfo pasic3_leds_info = {
 };
 
 /*
- * PASIC3 with DS1WM
+ * PASIC3 DS1WM
  */
 
 static struct resource pasic3_resources[] = {
@@ -492,7 +508,7 @@  static struct platform_device pasic3 = {
 };
 
 /*
- * USB "Transceiver"
+ * PXA UDC
  */
 
 static struct resource gpio_vbus_resource = {
@@ -695,7 +711,7 @@  static struct platform_device strataflash = {
 };
 
 /*
- * I2C
+ * PXA I2C main controller
  */
 
 static struct i2c_pxa_platform_data i2c_info = {