added header comments so it's easy to figure out where a method is defined in a specific header

Author: cedricbompart

platform/m6/kbd.c

@@ -5,23 +5,26 @@
 #include "kbd_common.h"
 #include "levent.h"
 
+KeyMap keymap[] = {
+    { 0, KEY_PLAYBACK, 0x00000002 }, // Found @0xe05e4cdc, levent 0x101 (uses inverted logic in physw_status)
+    { 0, KEY_WIFI,     0x00000004 }, // Found @0xe05e4ce4, levent 0x103 (uses inverted logic in physw_status)
+    { 1, KEY_MENU,     0x00000080 }, // Found @0xe05e4d1c, levent 0x15
+    { 1, KEY_UP,       0x00000100 }, // Found @0xe05e4d24, levent 0x06
+    { 1, KEY_DOWN,     0x00000200 }, // Found @0xe05e4d2c, levent 0x07
+    { 1, KEY_RIGHT,    0x00000400 }, // Found @0xe05e4d34, levent 0x09
+    { 1, KEY_LEFT,     0x00000800 }, // Found @0xe05e4d3c, levent 0x08
+    { 1, KEY_SET,      0x00001000 }, // Found @0xe05e4d44, levent 0x0a
+    { 1, KEY_ERASE,    0x00008000 }, // Found @0xe05e4d5c, levent 0x0b
+    { 2, KEY_VIDEO,    0x00002000 }, // Found @0xe05e4db4, levent 0x02
+    { 0, 0, 0 }
+};
+
+/**
+ * @header usb_remote.h
+ */
 int get_usb_bit() {
 	long usb_physw[3];
 	usb_physw[USB_IDX] = 0;
 	_kbd_read_keys_r2(usb_physw);
 	return ((usb_physw[USB_IDX] & USB_MASK) == USB_MASK);
 }
-
-KeyMap keymap[] = {
-    { 0, KEY_PLAYBACK        ,0x00000002 }, // Found @0xe05e4cdc, levent 0x101 (uses inverted logic in physw_status)
-    { 0, KEY_WIFI            ,0x00000004 }, // Found @0xe05e4ce4, levent 0x103 (uses inverted logic in physw_status)
-    { 1, KEY_MENU            ,0x00000080 }, // Found @0xe05e4d1c, levent 0x15
-    { 1, KEY_UP              ,0x00000100 }, // Found @0xe05e4d24, levent 0x06
-    { 1, KEY_DOWN            ,0x00000200 }, // Found @0xe05e4d2c, levent 0x07
-    { 1, KEY_RIGHT           ,0x00000400 }, // Found @0xe05e4d34, levent 0x09
-    { 1, KEY_LEFT            ,0x00000800 }, // Found @0xe05e4d3c, levent 0x08
-    { 1, KEY_SET             ,0x00001000 }, // Found @0xe05e4d44, levent 0x0a
-    { 1, KEY_ERASE           ,0x00008000 }, // Found @0xe05e4d5c, levent 0x0b
-    { 2, KEY_VIDEO           ,0x00002000 }, // Found @0xe05e4db4, levent 0x02
-    { 0, 0, 0 }
-};

platform/m6/lib.c

@@ -4,31 +4,47 @@
 
 #define LED_PR 0xd20b0994 // green LED on the back
 
+void shutdown_soft() {
+	_PostLogicalEventForNotPowerType(0x1005, 0);
+}
+
+/**
+ * @see main startup
+ */
 void shutdown() {
 	while (1)
 		_SleepTask(500);
 }
 
+/**
+ * @header debug_led.h
+ */
 void debug_led(int state) {
 	volatile long *p = (void*) LED_PR;
 	*p = ((state) ? 0x4d0002 : 0x4c0003);
 }
 
-// Power Led = first entry in table (led 0)
-// AF Assist Lamp = second entry in table (led 1)
+/**
+ * Power Led = first entry in table (led 0).
+ * AF Assist Lamp = second entry in table (led 1).
+ *
+ * @header debug_led.h
+ */
 void camera_set_led(int led, int state, __attribute__ ((unused))int bright) {
 	static char led_table[2] = { 0, 4 };
 	_LEDDrive(led_table[led % sizeof(led_table)], state <= 1 ? !state : state);
 }
 
-void shutdown_soft() {
-	_PostLogicalEventForNotPowerType(0x1005, 0);
-}
-
+/**
+ * @header keyboard.h
+ */
 void JogDial_CW(void) {
 	_PostLogicalEventToUI(0x872, 1); // RotateJogDialRight
 }
 
+/**
+ * @header keyboard.h
+ */
 void JogDial_CCW(void) {
 	_PostLogicalEventToUI(0x873, 1); // RotateJogDialLeft
 }

platform/m6/main.c

@@ -8,41 +8,54 @@ extern long link_bss_end;
 extern void boot();
 
 void startup() {
-    long *bss = &link_bss_start;
-    // sanity check
-    if ((long)&link_bss_end > (MEMISOSTART + MEMISOSIZE)) {
-        started();
-        shutdown();
-    }
-    // initialize .bss senment
-    while (bss<&link_bss_end)
-        *bss++ = 0;
-    boot();
+	long *bss = &link_bss_start;
+	// sanity check
+	if ((long) &link_bss_end > (MEMISOSTART + MEMISOSIZE)) {
+		started();
+		shutdown();
+	}
+	// initialize .bss senment
+	while (bss < &link_bss_end)
+		*bss++ = 0;
+	boot();
 }
 
 const int zoom_points = 1;
 extern int _GetLensCurrentFocalLength(void);
 extern int _GetLensWideFocalLength(void);
 
+/**
+ * @header shooting.h
+ */
 int get_effective_focal_length(__attribute__ ((unused))int zp) {
-    return _GetLensCurrentFocalLength() * 1600;
+	return _GetLensCurrentFocalLength() * 1600;
 }
 
+/**
+ * @header shooting.h
+ */
 int get_focal_length(__attribute__ ((unused))int zp) {
-    return _GetLensCurrentFocalLength() * 1000;
+	return _GetLensCurrentFocalLength() * 1000;
 }
 
+/**
+ * @header shooting.h
+ */
 int get_zoom_x(__attribute__ ((unused))int zp) {
-    return _GetLensCurrentFocalLength()*100 / (_GetLensWideFocalLength()*100);
+	// TODO: why the 100 ?
+	return _GetLensCurrentFocalLength() * 100/ (_GetLensWideFocalLength() * 100);
 }
 
-long get_vbatt_min()
-{
-    return 2*3300;
+/**
+ * @header battery.h
+ */
+long get_vbatt_min() {
+	return 2 * 3300;
 }
 
-
-long get_vbatt_max()
-{
-    return 2*4168;  // 4168 original battery just charged ASM1989
+/**
+ * @header battery.h
+ */
+long get_vbatt_max() {
+	return 2 * 4168;  // 4168 original battery just charged ASM1989
 }

platform/m6/notes.txt

@@ -1,12 +1,11 @@
---- EOS M6 ---
-
+---- EOS M6 ----
 processor:    DIGIC 7 (Cortex A9)
 architecture: ARMv7-a
 sensor:       22.3mm x 14.9mm CMOS
 aspect ratio: 3:2
 image size:   6000 x 4000
 raw:          14 bit
 iso:          100-25600
-interface:    micro USB, WiFi, NFC, Bluetooth
+interface:    micro USB, WiFi, Bluetooth
 port:         micro HDMI, 3.5mm stereo jack
 battery:      LP-E17

platform/m6/platform_camera.h

@@ -1,24 +1,26 @@
-// Camera - M6 - platform_camera.h
-
-// This file contains the various settings values specific to the EOS M6 camera.
-// This file is referenced via the 'include/camera.h' file and should not be loaded directly.
-
-// If adding a new settings value put a suitable default in 'include/camera.h',
-// along with documentation on what the setting does and how to determine the correct value.
-// If the setting should not have a default value then add it in 'include/camera.h'
-// using the '#undef' directive along with appropriate documentation.
-
-// Override any default values with your camera specific values in this file. Try and avoid
-// having override values that are the same as the default value.
-
-// When overriding a setting value there are two cases:
-// 1. If removing the value, because it does not apply to your camera, use the '#undef' directive.
-// 2. If changing the value it is best to use an '#undef' directive to remove the default value
-//    followed by a '#define' to set the new value.
-
-// When porting CHDK to a new camera, check the documentation in 'include/camera.h'
-// for information on each setting. If the default values are correct for your camera then
-// don't override them again in here.
+/**
+ * Camera - M6 - platform_camera.h
+ *
+ * This file contains the various settings values specific to the EOS M6 camera.
+ * This file is referenced via the 'include/camera.h' file and should not be loaded directly.
+ *
+ * If adding a new settings value put a suitable default in 'include/camera.h',
+ * along with documentation on what the setting does and how to determine the correct value.
+ * If the setting should not have a default value then add it in 'include/camera.h'
+ * using the '#undef' directive along with appropriate documentation.
+ *
+ * Override any default values with your camera specific values in this file. Try and avoid
+ * having override values that are the same as the default value.
+ *
+ * When overriding a setting value there are two cases:
+ *   1. If removing the value, because it does not apply to your camera, use the '#undef' directive.
+ *   2. If changing the value it is best to use an '#undef' directive to remove the default value
+ * followed by a '#define' to set the new value.
+ *
+ * When porting CHDK to a new camera, check the documentation in 'include/camera.h'
+ * for information on each setting. If the default values are correct for your camera then
+ * don't override them again in here.
+ */
 
 // from signature finder
 #define CAM_DRYOS                 1
@@ -51,5 +53,6 @@
 #define CAM_HAS_VIDEO_BUTTON      1
 #undef  CAM_HAS_ERASE_BUTTON
 
-#define CAM_3ARG_DebugAssert      1 // from Ghidra
+#define CAM_3ARG_DebugAssert      1 // confirmed with Ghidra
 #define CAM_FILE_COUNTER_IS_VAR   1
+#define CAM_DATE_FOLDER_NAMING    0x80

platform/m6/platform_kbd.h

@@ -1,8 +1,10 @@
 #ifndef PLATFORM_KBD_H
 #define PLATFORM_KBD_H
 
-// plaform specific keyboard defines, see core/kbd_common.c for documentation
-// non-standard key state update to handle inverted keys, etc
+/**
+ * Platform specific keyboard defines, see core/kbd_common.c for documentation
+ * non-standard key state update to handle inverted keys, etc
+ */
 
 // from signature finder
 #define SD_READONLY_FLAG    0x00000020 // Found @0xe05e4d0c, levent 0x30a

platform/m6/shooting.c

@@ -113,6 +113,7 @@ const ISOTable iso_table[] = {
     { 25, 25600, "25600", -1},
 };
 
+// TODO: map the rest
 const CapturemodeMap modemap[] = {
     { MODE_M,  32770 }, //
     { MODE_AV, 32771 }, //
@@ -122,26 +123,28 @@ const CapturemodeMap modemap[] = {
 
 #include "../generic/shooting.c"
 
+/**
+ * @header file_counter.h
+ */
 long get_file_next_counter() {
 	return get_file_counter();
 }
 
+/**
+ * @header file_counter.h
+ */
 long get_target_file_num() {
 	return get_exposure_counter();
 }
 
-#if defined(CAM_DATE_FOLDER_NAMING) // TODO: not really sure why there is a if/else ?
+/**
+ * @header file_counter.h
+ */
 void get_target_dir_name(char *out) {
 	if (!out) {
 		return;
 	}
 	extern void _GetImageFolder(char*, int, int, int);
 	_GetImageFolder(out, get_file_next_counter(), CAM_DATE_FOLDER_NAMING, time(NULL));
 }
-#else
-long get_target_dir_num() 
-{
-    return 0;
-}
-#endif
 

platform/m6/sub/101a/boot.c

@@ -1,3 +1,6 @@
+/**
+ * @see main startup
+ */
 void __attribute__((naked,noinline)) boot() {
 
 }

platform/m6/wrappers.c

@@ -1,23 +1,30 @@
 #include "../generic/wrappers.c"
 
+/**
+ * @header lens.h
+ */
 long lens_get_focus_pos() {
 	return _GetFocusLensSubjectDistance();
 }
 
+/**
+ * @header lens.h
+ */
 long lens_get_focus_pos_from_lens() {
 	return _GetFocusLensSubjectDistanceFromLens();
 }
 
+/**
+ * @header lens.h
+ */
 long lens_get_target_distance() {
 	return _GetCurrentTargetDistance();
 }
 
-int _EngDrvRead(int gpio_reg) {
-	extern int _EngDrvRead_FW(int*);
-	return _EngDrvRead_FW(&gpio_reg);
-}
-
-// DoMFLock: use _MFOn/_MFOff or _PT_MFOn/_PT_MFOff or _SS_MFOn/_SS_MFOff if defined in stubs_entry.S 
+/**
+ * @header lens.h
+ * @use _MFOn/_MFOff or _PT_MFOn/_PT_MFOff or _SS_MFOn/_SS_MFOff if defined in stubs_entry.S
+ */
 int DoMFLock(void) {
 	if (!camera_info.state.mode_play) {
 		_PT_MFOn();
@@ -26,10 +33,21 @@ int DoMFLock(void) {
 	return (0);
 }
 
+/**
+ * @header lens.h
+ */
 int UnlockMF(void) {
 	if (!camera_info.state.mode_play) {
 		_PT_MFOff();
 		return (1);
 	}
 	return (0);
 }
+
+/**
+ * @header lolevel.h
+ */
+int _EngDrvRead(int gpio_reg) {
+	extern int _EngDrvRead_FW(int*);
+	return _EngDrvRead_FW(&gpio_reg);
+}