forked from riot-appstore/PHiLIP
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature(docs): Update documentation before release
This was made to improve the documentation before the release. While testing the docs some bugs were found and fixed. -update gitignore for the board xml files -add more python version to the travis test -increase fw rev -increase if rev -fix if documentation -update doxgen and add main page -add release binaries -add pictures for fw arch -major update to readme file
- Loading branch information
1 parent
c8ce74d
commit bde7344
Showing
24 changed files
with
620 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,9 @@ NUCLEOF103RB/ | |
.settings | ||
.idea | ||
|
||
FW/NUCLEO-F103RB.xml | ||
FW/BLUEPILL.xml | ||
|
||
# Docs | ||
Docs/ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 170 additions & 0 deletions
170
IF/philip_pal/philip_pal/mem_map/PHiLIP_map_t_0_0_3.csv
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,170 @@ | ||
name,offset,total_size,type_size,type,description,access,array_size,bit_offset,bits,default,flag,invalid,max,min | ||
user_reg,0,256,1,uint8_t,Writable registers for user testing - Starts at 0 and increases 1 each register by default,3,256,,,,,,, | ||
sys.sn,256,12,1,uint8_t,Unique ID of the device,0,12,,,,DEVICE_SPECIFIC,,, | ||
sys.fw_rev,268,4,1,uint8_t,Firmware revision,0,4,,,,,0,, | ||
sys.if_rev,272,4,1,uint8_t,Interface revision - This corelates to the version of the memory map,0,4,,,,,,, | ||
sys.tick,276,,8,uint64_t,Tick in ms - Updates with the sys tick register every few ms,0,,,,,VOLATILE,,, | ||
sys.build_time.second,284,,1,uint8_t,The build time seconds,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.minute,285,,1,uint8_t,The build time minutes,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.hour,286,,1,uint8_t,The build time hours,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.day_of_month,287,,1,uint8_t,The build time day of month,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.day_of_week,288,,1,uint8_t,Not used,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.month,289,,1,uint8_t,The build time month,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.year,290,,1,uint8_t,The build time year (20XX),0,,,,,DEVICE_SPECIFIC,,, | ||
sys.build_time.res,291,1,1,uint8_t,Reserved bytes,0,1,,,,,,, | ||
sys.device_num,292,,4,uint32_t,The philip device designator - A constant number to identify philip firmware,0,,,,17061,,,, | ||
sys.sys_clk,296,,4,uint32_t,The frequency of the system clock in Hz,0,,,,,,,, | ||
sys.status,300,,1,sys_status_t,Status of system,0,,,,,DEVICE_SPECIFIC,,, | ||
sys.status.update,300,,1,,1:register configuration requires exceution for changes - 0:nothing to update,0,,0,1,,,,, | ||
sys.status.board,300,,1,,1:board is a bluepill - 0:board is a nucleo-f103rb,0,,1,1,,DEVICE_SPECIFIC,,, | ||
sys.mode,301,,1,sys_mode_t,Control register for device,1,,,,,,,, | ||
sys.mode.init,301,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
sys.mode.dut_rst,301,,1,,1:put DUT in reset mode - 0:run DUT,1,,1,1,,,,, | ||
sys.res,302,18,1,uint8_t,Reserved bytes,0,18,,,,,,, | ||
i2c.mode,320,,1,i2c_mode_t,Specific modes for I2C,1,,,,,,,, | ||
i2c.mode.init,320,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
i2c.mode.disable,320,,1,,0:periph is enabled - 1:periph is disabled,1,,1,1,,,,, | ||
i2c.mode.addr_10_bit,320,,1,,0:i2c address is 7 bit mode - 1:10 i2c address is 10 bit mode,1,,2,1,,,,, | ||
i2c.mode.general_call,320,,1,,0:disable general call - 1:enable general call,1,,3,1,,,,, | ||
i2c.mode.no_clk_stretch,320,,1,,0:slave can clock stretch - 1:disables clock stretch,1,,4,1,,,,, | ||
i2c.mode.reg_16_bit,320,,1,,0:8 bit register access - 1:16 bit register access mode,1,,5,1,,,,, | ||
i2c.mode.reg_16_big_endian,320,,1,,0:little endian if 16 bit register access - 1:big endian if 16 bit register access,1,,6,1,,,,, | ||
i2c.mode.nack_data,320,,1,,0:all data will ACK - 1:all data will NACK,1,,7,1,,,,, | ||
i2c.status,321,,1,i2c_status_t,Specific modes for I2C,0,,,,,,,, | ||
i2c.status.ovr,321,,1,,Overrun/Underrun: Request for new byte when not ready,0,,0,1,,,,, | ||
i2c.status.af,321,,1,,Acknowledge failure,0,,1,1,,,,, | ||
i2c.status.berr,321,,1,,Bus error: Non-valid position during a byte transfer,0,,2,1,,,,, | ||
i2c.status.gencall,321,,1,,General call address received,0,,3,1,,,,, | ||
i2c.status.busy,321,,1,,i2c bus is BUSY,0,,4,1,,,,, | ||
i2c.status.rsr,321,,1,,Repeated start detected,0,,5,1,,,,, | ||
i2c.clk_stretch_delay,322,,2,uint16_t,Clock stretch the first byte in us,1,,,,,,,, | ||
i2c.slave_addr_1,324,,2,uint16_t,Primary slave address,1,,,,85,,125,124,8 | ||
i2c.slave_addr_2,326,,2,uint16_t,Secondary slave address,1,,,,66,,126,124,8 | ||
i2c.state,328,,2,uint16_t,Current state of i2c frame - 0:initialized - 1:reading data - 2-write address recieved - 3-1st reg byte recieved - 4-writing data - 5-NACK - 6-stopped,0,,,,,,,, | ||
i2c.reg_index,330,,2,uint16_t,current index of i2c pointer,0,,,,,,,, | ||
i2c.start_reg_index,332,,2,uint16_t,start index of i2c pointer,0,,,,,,,, | ||
i2c.r_count,334,,1,uint8_t,Last read frame byte count - only in reg if_type 0,1,,,,,,,, | ||
i2c.w_count,335,,1,uint8_t,Last write frame byte count - only in reg if_type 0,1,,,,,,,, | ||
i2c.r_ticks,336,,4,uint32_t,Ticks for read byte,0,,,,,,,, | ||
i2c.w_ticks,340,,4,uint32_t,Ticks for write byte,0,,,,,,,, | ||
i2c.s_ticks,344,,4,uint32_t,Ticks for start and address,0,,,,,,,, | ||
i2c.f_r_ticks,348,,4,uint32_t,Ticks for full read frame after the address is acked,0,,,,,,,, | ||
i2c.f_w_ticks,352,,4,uint32_t,Ticks for full write frame,0,,,,,,,, | ||
i2c.res,356,28,1,uint8_t,Reserved bytes,0,28,,,,,,, | ||
spi.mode,384,,1,spi_mode_t,Specific spi modes,1,,,,,,,, | ||
spi.mode.init,384,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
spi.mode.disable,384,,1,,0:periph is enabled - 1:periph is disabled,1,,1,1,,,,, | ||
spi.mode.cpha,384,,1,,0:CK to 0 when idle - 1:CK to 1 when idle,1,,2,1,,,,, | ||
spi.mode.cpol,384,,1,,0:the first clock transition is the first data capture edge - 1:the second clock transition is the first data capture edge,1,,3,1,,,,, | ||
spi.mode.if_type,384,,1,,Sets spi modes since slave cannot responds immediately - 0:access registers with spi - 1:preloads reg address to 0 for high speed tests - 2:echos SPI bytes - 3:always output user reg 0 (use for timing),1,,4,2,,,,, | ||
spi.mode.reg_16_bit,384,,1,,0:8 bit register access - 1:16 bit register access mode,1,,6,1,,,,, | ||
spi.mode.reg_16_big_endian,384,,1,,0:little endian for 16 bit mode - 1:big endian for 16 bit mode,1,,7,1,,,,, | ||
spi.status,385,,1,spi_status_t,Spi status register,0,,,,,,,, | ||
spi.status.bsy,385,,1,,Busy flag,0,,0,1,,,,, | ||
spi.status.ovr,385,,1,,Overrun flag,0,,1,1,,,,, | ||
spi.status.modf,385,,1,,Mode fault,0,,2,1,,,,, | ||
spi.status.udr,385,,1,,Underrun flag,0,,3,1,,,,, | ||
spi.status.clk,385,,1,,0:sclk line low - 1:sclk line high,0,,4,1,,,,, | ||
spi.status.start_clk,385,,1,,SCLK reading at start of frame - 0:sclk line low - 1:sclk line high,0,,5,1,,,,, | ||
spi.status.end_clk,385,,1,,SCLK reading at end of frame - 0:sclk line low - 1:sclk line high,0,,6,1,,,,, | ||
spi.status.index_err,385,,1,,Register index error,0,,7,1,,,,, | ||
spi.state,386,,2,uint16_t,Current state of the spi bus - 0:initialized - 1:NSS pin just lowered - 2:writing to reg - 3:reading reg - 4:transfering data - 5:NSS up and finished,0,,,,,,,, | ||
spi.reg_index,388,,2,uint16_t,Current index of reg pointer,0,,,,,,,, | ||
spi.start_reg_index,390,,2,uint16_t,Start index of reg pointer,0,,,,,,,, | ||
spi.r_count,392,,1,uint8_t,Last read frame byte count,0,,,,,,,, | ||
spi.w_count,393,,1,uint8_t,Last write frame byte count,0,,,,,,,, | ||
spi.transfer_count,394,,1,uint8_t,The amount of bytes in the last transfer ,0,,,,,,,, | ||
spi.frame_ticks,395,,4,uint32_t,Ticks per frame,0,,,,,,,, | ||
spi.byte_ticks,399,,4,uint32_t,Ticks per byte,0,,,,,,,, | ||
spi.prev_ticks,403,,4,uint32_t,Holder for previous byte ticks,0,,,,,,,, | ||
spi.res,407,9,1,uint8_t,Reserved bytes,0,9,,,,,,, | ||
uart.mode,416,,2,uart_mode_t,UART mode settings,1,,,,,,,, | ||
uart.mode.init,416,,2,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
uart.mode.disable,416,,2,,0:periph is enabled - 1:periph is disabled,1,,1,1,,,,, | ||
uart.mode.if_type,416,,2,,0:echos - 1:echos and adds one - 2:reads application registers - 3:constantly transmits,1,,2,2,,,,, | ||
uart.mode.stop_bits,416,,2,,0:1 stop bit - 1:2 stop bits,1,,4,1,,,,, | ||
uart.mode.parity,416,,2,,0:no parity - 1:even parity - 2:odd parity,1,,5,2,,,,, | ||
uart.mode.rts,416,,2,,RTS pin state,1,,7,1,,,,, | ||
uart.mode.data_bits,416,,2,,0:8 data bits - 1:7 data bits,1,,8,1,,,,, | ||
uart.baud,418,,4,uint32_t,Baudrate,1,,,,,,,, | ||
uart.mask_msb,422,,1,uint8_t,Masks the data coming in if 7 bit mode,0,,,,,,,, | ||
uart.rx_count,423,,2,uint16_t,Number of received bytes,0,,,,,,,, | ||
uart.tx_count,425,,2,uint16_t,Number of transmitted bytes,0,,,,,,,, | ||
uart.status,427,,1,uart_status_t,UART status register,0,,,,,,,, | ||
uart.status.cts,427,,1,,CTS pin state,0,,0,1,,,,, | ||
uart.status.pe,427,,1,,Parity error,0,,1,1,,,,, | ||
uart.status.fe,427,,1,,Framing error,0,,2,1,,,,, | ||
uart.status.nf,427,,1,,Noise detected flag,0,,3,1,,,,, | ||
uart.status.ore,427,,1,,Overrun error,0,,4,1,,,,, | ||
uart.res,428,4,1,uint8_t,Reserved bytes,0,4,,,,,,, | ||
rtc.mode,432,,1,basic_mode_t,basic mode for rtc settings,1,,,,,,,, | ||
rtc.mode.init,432,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
rtc.mode.disable,432,,1,,0:periph is enabled - 1:periph is disabled,1,,1,1,,,,, | ||
rtc.second,433,,1,uint8_t,Seconds of rtc,0,,,,,VOLATILE,,59,0 | ||
rtc.minute,434,,1,uint8_t,Minutes to set of rtc,0,,,,,VOLATILE,,59,0 | ||
rtc.hour,435,,1,uint8_t,Hours to set of rtc,0,,,,,VOLATILE,,23,0 | ||
rtc.day,436,,2,uint16_t,Days to set of rtc,0,,,,,VOLATILE,,, | ||
rtc.set_second,438,,1,uint8_t,Seconds to set of rtc,1,,,,,,,59,0 | ||
rtc.set_minute,439,,1,uint8_t,Minutes to set of rtc,1,,,,,,,59,0 | ||
rtc.set_hour,440,,1,uint8_t,Hours to set of rtc,1,,,,,,,23,0 | ||
rtc.set_day,441,,2,uint16_t,Days to set of rtc,1,,,,,,,, | ||
rtc.res,443,5,1,uint8_t,Reserved bytes,0,5,,,,,,, | ||
adc.mode,448,,1,adc_mode_t,Mode settings for the ADC,1,,,,,,,, | ||
adc.mode.init,448,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
adc.mode.enable,448,,1,,0:periph is disabled - 1:periph is enabled,1,,1,1,,,,, | ||
adc.mode.fast_sample,448,,1,,0:slow sample rate - 1:fastest sample rate,1,,2,1,,,,, | ||
adc.num_of_samples,449,,4,uint32_t,Number of sample in the sum,1,,,,1024,,,1048575,0 | ||
adc.counter,453,,1,uint8_t,Sum counter increases when available,0,,,,,,,, | ||
adc.index,454,,4,uint32_t,Sample index increases when new sample read,0,,,,,,,, | ||
adc.sample,458,,2,uint16_t,Current 12 bit sample value,0,,,,,,,, | ||
adc.sum,460,,4,uint32_t,Sum of the last num_of_samples,0,,,,,,,, | ||
adc.current_sum,464,,4,uint32_t,Current collection of the sums,0,,,,,,,, | ||
adc.res,468,12,1,uint8_t,Reserved bytes,0,12,,,,,,, | ||
pwm.mode,480,,1,basic_mode_t,basic mode for pwm settings,1,,,,,,,, | ||
pwm.mode.init,480,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
pwm.mode.disable,480,,1,,0:periph is enabled - 1:periph is disabled,1,,1,1,,,,, | ||
pwm.status,481,,1,uint8_t,Unimplemented status for padding,0,,,,,,,, | ||
pwm.duty_cycle,482,,2,uint16_t,The calculated duty cycle in percent/100,0,,,,,,,, | ||
pwm.period,484,,4,uint32_t,The calculated period in us,0,,,,,,,, | ||
pwm.h_ticks,488,,4,uint32_t,Settable high time in sys clock ticks,1,,,,10000,,,, | ||
pwm.l_ticks,492,,4,uint32_t,Settable low time in sys clock ticks,1,,,,10000,,,, | ||
pwm.res,496,16,1,uint8_t,Reserved bytes,0,16,,,,,,, | ||
dac.mode,512,,1,basic_mode_t,,1,,,,,,,, | ||
dac.mode.init,512,,1,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
dac.mode.disable,512,,1,,0:periph is enabled - 1:periph is disabled,1,,1,1,,,,, | ||
dac.status,513,,1,uint8_t,Unimplemented status for padding,0,,,,,,,, | ||
dac.level,514,,2,uint16_t,The percent/100 of output level,1,,,,5000,,,, | ||
dac.res,516,12,1,uint8_t,Reserved bytes,0,12,,,,,,, | ||
gpio[0].mode,528,,2,gpio_mode_t,The selected GPIO mode,1,,,,,,,, | ||
gpio[0].mode.init,528,,2,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
gpio[0].mode.io_type,528,,2,,0:high impedance input - 1:push pull output - 2:open drain output - 3:interrupts and saves event,1,,1,2,,,,, | ||
gpio[0].mode.level,528,,2,,If output sets gpio level - 0:low - 1:high,1,,3,1,,,,, | ||
gpio[0].mode.pull,528,,2,,pull of the resistor - 0:none - 1:pullup - 2:pulldown,1,,4,2,,,,, | ||
gpio[0].mode.tick_div,528,,2,,for trace tick divisor - max should be 16 for interface,1,,6,5,,,,, | ||
gpio[0].status,530,,1,gpio_status_t,The status of the GPIO,0,,,,,VOLATILE,,, | ||
gpio[0].status.level,530,,1,,The io level of the pin 0=low 1=high,0,,0,1,,VOLATILE,,, | ||
gpio[0].res,531,1,1,uint8_t,Reserved bytes,0,1,,,,,,, | ||
gpio[1].mode,532,,2,gpio_mode_t,The selected GPIO mode,1,,,,,,,, | ||
gpio[1].mode.init,532,,2,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
gpio[1].mode.io_type,532,,2,,0:high impedance input - 1:push pull output - 2:open drain output - 3:interrupts and saves event,1,,1,2,,,,, | ||
gpio[1].mode.level,532,,2,,If output sets gpio level - 0:low - 1:high,1,,3,1,,,,, | ||
gpio[1].mode.pull,532,,2,,pull of the resistor - 0:none - 1:pullup - 2:pulldown,1,,4,2,,,,, | ||
gpio[1].mode.tick_div,532,,2,,for trace tick divisor - max should be 16 for interface,1,,6,5,,,,, | ||
gpio[1].status,534,,1,gpio_status_t,The status of the GPIO,0,,,,,VOLATILE,,, | ||
gpio[1].status.level,534,,1,,The io level of the pin - 0:low - 1:high,0,,0,1,,VOLATILE,,, | ||
gpio[1].res,535,1,1,uint8_t,Reserved bytes,0,1,,,,,,, | ||
gpio[2].mode,536,,2,gpio_mode_t,,1,,,,,,,, | ||
gpio[2].mode.init,536,,2,,0:periph will initialize on execute - 1:periph initialized,1,,0,1,,,,, | ||
gpio[2].mode.io_type,536,,2,,0:high impedance input - 1:push pull output - 2:open drain output - 3:interrupts and saves event,1,,1,2,,,,, | ||
gpio[2].mode.level,536,,2,,If output sets gpio level - 0:low - 1:high,1,,3,1,,,,, | ||
gpio[2].mode.pull,536,,2,,pull of the resistor - 0:none - 1:pullup - 2:pulldown,1,,4,2,,,,, | ||
gpio[2].mode.tick_div,536,,2,,for trace tick divisor - max should be 16 for interface,1,,6,5,,,,, | ||
gpio[2].status,538,,1,gpio_status_t,The status of the GPIO,0,,,,,VOLATILE,,, | ||
gpio[2].status.level,538,,1,,The io level of the pin - 0:low - 1:high,0,,0,1,,VOLATILE,,, | ||
gpio[2].res,539,1,1,uint8_t,Reserved bytes,0,1,,,,,,, | ||
trace.index,540,,4,uint32_t,Index of the current trace,0,,,,,,,, | ||
trace.tick_div,544,32,1,uint8_t,The tick divisor of the event - max should be 16 for interface,0,32,,,,,,, | ||
trace.source,576,32,1,uint8_t,The event source of the event - 0:no source selected - 1:DEBUG0 pin - 2:DEBUG1 pin - 3:DEBUG2 pin,0,32,,,,,,, | ||
trace.value,608,64,2,uint16_t,The value of the event - 0:falling edge interrupt - 1:rising edge interrupt,0,32,,,,,,, | ||
trace.tick,672,128,4,uint32_t,The tick when the event occured,0,32,,,,,,, | ||
res,800,224,1,uint8_t,Reserved bytes,0,224,,,,,,, |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,7 +15,7 @@ | |
|
||
setup( | ||
name="philip_pal", | ||
version="0.0.1", | ||
version="0.0.2", | ||
author="Kevin Weiss", | ||
author_email="[email protected]", | ||
license="MIT", | ||
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Oops, something went wrong.