Skip to content

Commit 9bb5076

Browse files
committed
Github doc fixup
1 parent d24e16b commit 9bb5076

File tree

1 file changed

+48
-38
lines changed

1 file changed

+48
-38
lines changed

README.md

Lines changed: 48 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -207,21 +207,21 @@ and SRAM usage by allowing CDC to be disabled (or USB completely disabled).
207207
There are up to four clock source choices, depending on board features and microcontroller. Since currently
208208
the cpu must run at 48MHz, the PLL or DFLL must be used (the SAMC can use OSC48M).
209209

210-
* 32KHZ_CRYSTAL (default)
211-
* Uses both XOSC32K and FDPLL96M
212-
* High long-term accuracy, slow startup, medium current (PLL)
210+
### 32KHZ_CRYSTAL (default)
211+
* Uses both XOSC32K and FDPLL96M
212+
* High long-term accuracy, slow startup, medium current (PLL)
213213

214-
* HIGH_SPEED_CRYSTAL
215-
* Uses both XOSC and FDPLL96M
216-
* High accuracy, medium startup, high current (XOSC and PLL)
214+
### HIGH_SPEED_CRYSTAL
215+
* Uses both XOSC and FDPLL96M
216+
* High accuracy, medium startup, high current (XOSC and PLL)
217217

218-
* INTERNAL_OSCILLATOR
219-
* Uses DFLL48M in open-loop mode (SAMC uses OSC48M)
220-
* Low accuracy, fast startup, medium-low current (low current with SAMC)
218+
### INTERNAL_OSCILLATOR
219+
* Uses DFLL48M in open-loop mode (SAMC uses OSC48M)
220+
* Low accuracy, fast startup, medium-low current (low current with SAMC)
221221

222-
* INTERNAL_USB_CALIBRATED_OSCILLATOR (not available with SAMC)
223-
* Uses DFLL48M in closed-loop mode
224-
* High accuracy, medium-fast startup, medium current
222+
### INTERNAL_USB_CALIBRATED_OSCILLATOR (not available with SAMC)
223+
* Uses DFLL48M in closed-loop mode
224+
* High accuracy, medium-fast startup, medium current
225225

226226
### SAMD
227227

@@ -307,19 +307,19 @@ NVM OTP (factory calibration values).
307307

308308
## Analog Reference
309309

310-
* D21
311-
* AR_DEFAULT uses 1/2X gain on each input.
312-
* The external reference should be between 1.0V and VDDANA-0.6V.
310+
### D21
311+
* AR_DEFAULT uses 1/2X gain on each input.
312+
* The external reference should be between 1.0V and VDDANA-0.6V.
313313

314-
* L21
315-
* AR_DEFAULT = AR_INTERNAL_INTVCC2
316-
* Both AR_INTREF and AR_INTERNAL1V0 has the same effect as AR_INTREF_1V0.
317-
* The external reference should be between 1v and VDDANA-0.6v=2.7v.
314+
### L21
315+
* AR_DEFAULT = AR_INTERNAL_INTVCC2
316+
* Both AR_INTREF and AR_INTERNAL1V0 has the same effect as AR_INTREF_1V0.
317+
* The external reference should be between 1v and VDDANA-0.6v=2.7v.
318318

319-
* C21
320-
* AR_DEFAULT = AR_INTERNAL_INTVCC2
321-
* Both AR_INTREF and AR_INTERNAL1V0 has the same effect as AR_INTREF_1V024.
322-
* The external reference should be between 1v and VDDANA-0.6v=2.7v.
319+
### C21
320+
* AR_DEFAULT = AR_INTERNAL_INTVCC2
321+
* Both AR_INTREF and AR_INTERNAL1V0 has the same effect as AR_INTREF_1V024.
322+
* The external reference should be between 1v and VDDANA-0.6v=2.7v.
323323

324324
**Warning : The maximum reference voltage is Vcc (up to 3.6 volts for the SAMD/SAML, 5V for the SAMC)**
325325

@@ -333,16 +333,16 @@ AR_INTERNAL_INTVCC0 | 1/1.48 VCC | AR_INTREF_1V0 | 1.00V | AR_IN
333333
AR_INTERNAL_INTVCC1 | 1/2 VCC | AR_INTREF_1V1 | 1.10V | AR_INTREF_2V048 | 2.048V
334334
AR_EXTERNAL_REFA | REFA | AR_INTREF_1V2 | 1.20V | AR_INTREF_4V096 | 4.096V
335335
AR_EXTERNAL_REFB | REFB | AR_INTREF_1V25 | 1.25V | AR_INTERNAL1V0 | 1.024V
336-
| | AR_INTREF_2V0 | 2.00V | AR_INTERNAL_INTVCC0 | 1/1.6 VCC
337-
| | AR_INTREF_2V2 | 2.20V | AR_INTERNAL_INTVCC1 | 1/2 VCC
338-
| | AR_INTREF_2V4 | 2.40V | AR_INTERNAL_INTVCC2 | VCC
339-
| | AR_INTREF_2V5 | 2.50V | AR_EXTERNAL_REFA | REFA
340-
| | AR_INTERNAL1V0 | 1.00V | AR_EXTERNAL_DAC | DAC
341-
| | AR_INTERNAL_INTVCC0 | 1/1.6 VCC | |
342-
| | AR_INTERNAL_INTVCC1 | 1/2 VCC | |
343-
| | AR_INTERNAL_INTVCC2 | VCC | |
344-
| | AR_EXTERNAL_REFA | REFA | |
345-
| | AR_EXTERNAL_REFB | REFB | |
336+
--- | | AR_INTREF_2V0 | 2.00V | AR_INTERNAL_INTVCC0 | 1/1.6 VCC
337+
--- | | AR_INTREF_2V2 | 2.20V | AR_INTERNAL_INTVCC1 | 1/2 VCC
338+
--- | | AR_INTREF_2V4 | 2.40V | AR_INTERNAL_INTVCC2 | VCC
339+
--- | | AR_INTREF_2V5 | 2.50V | AR_EXTERNAL_REFA | REFA
340+
--- | | AR_INTERNAL1V0 | 1.00V | AR_EXTERNAL_DAC | DAC
341+
--- | | AR_INTERNAL_INTVCC0 | 1/1.6 VCC | |
342+
--- | | AR_INTERNAL_INTVCC1 | 1/2 VCC | |
343+
--- | | AR_INTERNAL_INTVCC2 | VCC | |
344+
--- | | AR_EXTERNAL_REFA | REFA | |
345+
--- | | AR_EXTERNAL_REFB | REFB | |
346346

347347
### Common Settings
348348

@@ -404,21 +404,17 @@ AR_EXTERNAL = AR_EXTERNAL_REFA
404404
TODO
405405

406406

407-
## Differences Between MattairTech and Arduino Cores
408-
409-
* TODO
407+
## Differences Between MattairTech and Arduino Cores (TODO)
410408

411409
* Table summarizing which core files are modified and by how much
412410
* Communications interfaces are mostly unchanged, including USB
413411
* Changes due to adding/changing features vs porting to new chip
414-
415412
* All pins (digital and analog) setup in STARTUP mode (enable INEN and set default pull direction to pullup (pullup will not be enabled))
416413
* INEN enabled for both input and output (but not analog)
417414
* pinPeripheral now handles disabling the DAC (if active). Note that on the L21, the DAC output would
418415
interfere with other peripherals if left enabled, even if the anaolog peripheral is not selected.
419416
* Pull resistors enabled only if pin attributes allow and only if pin is not configured as output.
420417
* Pull direction (pullup or pulldown) is now set with pinMode only (defaults to pullup if pinMode never called).
421-
422418
* At least on the L21, pin A31 must be set as an input. It is possible that debugger probe detection is being falsely
423419
detected (even with a pullup on A31 (SWCLK)), which would change the peripheral mux of A31 to COM.
424420
This might not normally be a problem, but one strange effect is that Serial2 loses characters if pin A31 is not set as INPUT.
@@ -839,6 +835,7 @@ This fork developed by Justin Mattair of MattairTech LLC.
839835

840836
```
841837
Copyright (c) 2015 Arduino LLC. All right reserved.
838+
Copyright (c) 2017 MattairTech LLC. All right reserved.
842839
843840
This library is free software; you can redistribute it and/or
844841
modify it under the terms of the GNU Lesser General Public
@@ -854,3 +851,16 @@ This fork developed by Justin Mattair of MattairTech LLC.
854851
License along with this library; if not, write to the Free Software
855852
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
856853
```
854+
855+
### Petit FatFS
856+
857+
Petit FatFs module is an open source software to implement FAT file system to
858+
small embedded systems. This is a free software and is opened for education,
859+
research and commercial developments under license policy of following trems.
860+
861+
Copyright (C) 2014, ChaN, all right reserved.
862+
863+
* The Petit FatFs module is a free software and there is NO WARRANTY.
864+
* No restriction on use. You can use, modify and redistribute it for
865+
personal, non-profit or commercial use UNDER YOUR RESPONSIBILITY.
866+
* Redistributions of source code must retain the above copyright notice.

0 commit comments

Comments
 (0)