Add helpful comments

Author: CodeInfrastructure23

src/TMCStepper.h

@@ -1,3 +1,20 @@
+/**
+ * TMCStepper library by @teemuatlut
+ *
+ * TMCStepper.h
+ * Classes for all stepper types. Inheritance hierarchy:
+ *
+ * TMCStepper
+ *   TMC2130Stepper
+ *     TMC2160Stepper
+ *       TMC5130Stepper
+ *         TMC5160Stepper
+ *           TMC5161Stepper
+ *   TMC2208Stepper
+ *     TMC2209Stepper
+ *     TMC2224Stepper
+ * TMC2660Stepper
+ */
 #pragma once
 
 //#define TMCDEBUG

src/source/CHOPCONF.cpp

@@ -1,9 +1,17 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * CHOPCONF.cpp - CHOPCONF Chopper Configuration
+ * TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161), TMC5160, TMC2208 (TMC2209, TMC2224), TMC2660
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 
 #define SET_REG(SETTING) CHOPCONF_register.SETTING = B; write(CHOPCONF_register.address, CHOPCONF_register.sr)
 
-// CHOPCONF
+//
+// TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161)
+//
+
 uint32_t TMC2130Stepper::CHOPCONF() {
 	return read(CHOPCONF_register.address);
 }
@@ -46,11 +54,19 @@ bool 	TMC2130Stepper::intpol()	{ CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.in
 bool 	TMC2130Stepper::dedge()		{ CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.dedge;	}
 bool 	TMC2130Stepper::diss2g()	{ CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.diss2g;	}
 
+//
+// TMC5160 (TMC5161)
+//
+
 void TMC5160Stepper::diss2vs(bool B){ SET_REG(diss2vs); }
 void TMC5160Stepper::tpfd(uint8_t B){ SET_REG(tpfd);	}
 bool TMC5160Stepper::diss2vs()		{ CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.diss2vs; }
 uint8_t TMC5160Stepper::tpfd()		{ CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.tpfd;	}
 
+//
+// TMC2208 (TMC2209, TMC2224)
+//
+
 void TMC2208Stepper::CHOPCONF(uint32_t input) {
 	CHOPCONF_register.sr = input;
 	write(CHOPCONF_register.address, CHOPCONF_register.sr);
@@ -80,6 +96,10 @@ bool 	TMC2208Stepper::dedge()		{ TMC2208_n::CHOPCONF_t r{0}; r.sr = CHOPCONF();
 bool 	TMC2208Stepper::diss2g()	{ TMC2208_n::CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.diss2g; 	}
 bool 	TMC2208Stepper::diss2vs()	{ TMC2208_n::CHOPCONF_t r{0}; r.sr = CHOPCONF(); return r.diss2vs; 	}
 
+//
+// TMC2660
+//
+
 #define GET_REG_2660(SETTING) return CHOPCONF_register.SETTING;
 
 uint32_t TMC2660Stepper::CHOPCONF() { return CHOPCONF_register.sr; }

src/source/COOLCONF.cpp

@@ -1,10 +1,18 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * COOLCONF.cpp - COOLCONF CoolStep Configuration
+ * TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161), TMC2209
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 
 #define SET_REG(SETTING) COOLCONF_register.SETTING = B; write(COOLCONF_register.address, COOLCONF_register.sr);
 #define GET_REG(SETTING) return COOLCONF_register.SETTING;
 
-// COOLCONF
+//
+// TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161)
+//
+
 uint32_t TMC2130Stepper::COOLCONF() { return COOLCONF_register.sr; }
 void TMC2130Stepper::COOLCONF(uint32_t input) {
 	COOLCONF_register.sr = input;
@@ -33,6 +41,10 @@ int8_t TMC2130Stepper::sgt() {
 	return val;
 }
 
+//
+// TMC2209
+//
+
 uint16_t TMC2209Stepper::COOLCONF() { return COOLCONF_register.sr; }
 void TMC2209Stepper::COOLCONF(uint16_t input) {
 	COOLCONF_register.sr = input;

src/source/DRVCONF.cpp

@@ -1,3 +1,8 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * DRVCONF.cpp - Driver Configuration
+ * TMC2660
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 

src/source/DRVCTRL.cpp

@@ -1,3 +1,8 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * DRVCTRL.cpp - Driver Control
+ * TMC2660
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 

src/source/DRVSTATUS.cpp

@@ -1,3 +1,8 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * DRVSTATUS.cpp - Driver Status
+ * TMC2660
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 

src/source/DRV_CONF.cpp

@@ -1,3 +1,8 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * DRV_CONF.cpp - DRV_CONF Configuration
+ * TMC2160 (TMC5130, TMC5160, TMC5161)
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 

src/source/DRV_STATUS.cpp

@@ -1,8 +1,17 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * DRV_STATUS.cpp - Driver Status
+ * TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161), TMC2208 (TMC2209, TMC2224)
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 
 #define GET_REG(NS, SETTING) NS::DRV_STATUS_t r{0}; r.sr = DRV_STATUS(); return r.SETTING
 
+//
+// TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161)
+//
+
 uint32_t TMC2130Stepper::DRV_STATUS() { return read(DRV_STATUS_t::address); }
 
 uint16_t TMC2130Stepper::sg_result(){ GET_REG(TMC2130_n, sg_result); 	}
@@ -17,6 +26,10 @@ bool TMC2130Stepper::ola()			{ GET_REG(TMC2130_n, ola); 			}
 bool TMC2130Stepper::olb()			{ GET_REG(TMC2130_n, olb); 			}
 bool TMC2130Stepper::stst()			{ GET_REG(TMC2130_n, stst); 		}
 
+//
+// TMC2208 (TMC2209, TMC2224)
+//
+
 uint32_t TMC2208Stepper::DRV_STATUS() {
 	return read(TMC2208_n::DRV_STATUS_t::address);
 }

src/source/ENCMODE.cpp

@@ -1,10 +1,18 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * ENCMODE.cpp - Driver Status
+ * TMC5130 (TMC5160, TMC5161)
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 
 #define SET_REG(SETTING) ENCMODE_register.SETTING = B; write(ENCMODE_register.address, ENCMODE_register.sr);
 #define GET_REG(SETTING) ENCMODE_t r{0}; r.sr = ENCMODE(); return r.SETTING;
 
-// ENCMODE
+//
+// TMC5130 (TMC5160, TMC5161)
+//
+
 uint32_t TMC5130Stepper::ENCMODE() {
 	return read(ENCMODE_register.address);
 }

src/source/GCONF.cpp

@@ -1,9 +1,17 @@
+/**
+ * TMCStepper library by @teemuatlut
+ * ENCMODE.cpp - Driver Status
+ * TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161), TMC5160 (TMC5161), TMC2208 (TMC2209, TMC2224)
+ */
 #include "TMCStepper.h"
 #include "TMC_MACROS.h"
 
 #define SET_REG(SETTING) GCONF_register.SETTING = B; write(GCONF_register.address, GCONF_register.sr)
 
-// GCONF
+//
+// TMC2130 (TMC2160, TMC5130, TMC5160, TMC5161)
+//
+
 uint32_t TMC2130Stepper::GCONF() {
 	return read(GCONF_register.address);
 }
@@ -48,6 +56,10 @@ bool TMC2130Stepper::small_hysteresis() 			{ GCONF_t r{0}; r.sr = GCONF(); retur
 bool TMC2130Stepper::stop_enable() 					{ GCONF_t r{0}; r.sr = GCONF(); return r.stop_enable;			}
 bool TMC2130Stepper::direct_mode() 					{ GCONF_t r{0}; r.sr = GCONF(); return r.direct_mode;			}
 
+//
+// TMC5160 (TMC5161)
+//
+
 /*
 bit 18 not implemented:
 test_mode 0:
@@ -64,6 +76,10 @@ bool TMC5160Stepper::recalibrate()					{ GCONF_t r{0}; r.sr = GCONF(); return r.
 bool TMC5160Stepper::faststandstill()				{ GCONF_t r{0}; r.sr = GCONF(); return r.faststandstill;	}
 bool TMC5160Stepper::multistep_filt()				{ GCONF_t r{0}; r.sr = GCONF(); return r.multistep_filt;	}
 
+//
+// TMC2208 (TMC2209, TMC2224)
+//
+
 uint32_t TMC2208Stepper::GCONF() {
 	return read(GCONF_register.address);
 }