Skip to content

Commit

Permalink
Merge pull request #11376 from kyle-cypress/pr/pdl-1.3-doc
Browse files Browse the repository at this point in the history
Update PDL documentation and metadata
  • Loading branch information
0xc0170 authored Sep 5, 2019
2 parents 978296a + b140b70 commit f06145d
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 48 deletions.
13 changes: 8 additions & 5 deletions targets/TARGET_Cypress/TARGET_PSOC6/psoc6pdl/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,25 @@ New Drivers
* [CAN FD 1.0](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__canfd.html)

Updated Drivers
* [DMAC 1.10](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__dmac.html)
* [SD Host 1.30](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__sd_host.html)
* [SMIF 1.40](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__smif.html)
* [Startup 2.60](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__system__config.html)
* [SysPm 4.30](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__syspm.html)
* [USBFS 2.10](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__usbfs__dev__drv.html)

Drivers with patch version updates
* [Crypto 2.30.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__crypto.html)
* [CTB 1.10.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__ctb.html)
* [DMAC 1.10](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__dmac.html)
* [eFuse 1.10.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__efuse.html)
* [Flash 3.30.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__flash.html)
* [PDM_PCM 2.20.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__pdm_pcm.html)
* [RTC 2.20.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__rtc.html)
* [SAR 1.20.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__sar.html)
* [SCB 2.30.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__scb.html)
* [SD Host 1.30](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__sd_host.html)
* [SMIF 1.40](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__smif.html)
* [SysClk 1.40.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__sysclk.html)
* [SysLib 2.40.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__syslib.html)
* [SysPm 4.30](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__syspm.html)
* [TCPWM 1.10.1](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__tcpwm.html)
* [USBFS 2.10](https://cypresssemiconductorco.github.io/psoc6pdl/pdl_api_reference_manual/html/group__group__usbfs__dev__drv.html)

### Known Issues
None
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,13 @@
* Refer to \ref group_sysclk driver API for more detail about clock
* configuration.
*
* The FLL (Clock Path 0) with ECO also can be used as an alternative USB source
* with the next configuration settings, for 48 MHz:
* \snippet usbfs/snippet/main.c snipped_Cy_USBFS_Dev_Drv_fllConfig48MHz
* And for 96 MHz:
* \snippet usbfs/snippet/main.c snipped_Cy_USBFS_Dev_Drv_fllConfig96MHz
* Use these structures with \ref Cy_SysClk_FllManualConfigure
*
********************************************************************************
* \subsection group_usbfs_dev_drv_dma Assign and Route DMA Channels
********************************************************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@
<ParamBool id="btHostWake" name="Enable" group="BT Wake-Up Configurations" default="false" visible="true" editable="true" desc="Enable/disable the host wake configuration. If disabled, host wake configuration defined by BSP will be used." />

<!-- Host wake settings -->
<ParamBlock id="hostWakePin" blockType="ioss\.port\.pin" name="Host-Wake-Up Signal" group="Host-Wake-Up Configuration" canBeEmpty="true" visible="`${btHostWake}`" desc="Select the host IRQ signal connected to BT_HOST_WAKE signal." />
<ParamBlock id="hostWakePin" blockType="ioss\.port\.pin" name="Host-Wake-Up Signal" group="Host-Wake-Up Configuration" canBeEmpty="true" visible="`${btHostWake}`" desc="Select the host IRQ signal connected to BT_HOST_WAKE signal. The pin must be enabled on the Pins tab to be added as an option to the pull-down menu. If left empty, the pin will be unconfigured." />
<ParamBool id="hostWakeConnected" name="hostWakeConnected" group="Internal" default="`${hostWakePin ne &quot;&quot; &amp;&amp; btHostWake}`" visible="false" editable="false" desc="True, if HOST_WAKE is connected" />
<ParamChoice id="hostWakeIrqEvent" name="Host-Wake-Up IRQ Event" group="Host-Wake-Up Configuration" default="CYCFG_BT_WAKE_EVENT_ACTIVE_LOW" visible="`${hostWakeConnected}`" editable="true" desc="Select the trigger condition for the BT_HOST_WAKE signal.">
<Entry name="Falling Edge" value="CYCFG_BT_WAKE_EVENT_ACTIVE_LOW" visible="true" />
<Entry name="Rising Edge" value="CYCFG_BT_WAKE_EVENT_ACTIVE_HIGH" visible="true" />
</ParamChoice>

<!-- Device wake settings -->
<ParamBlock id="devWakePin" blockType="ioss\.port\.pin" name="Device-Wake-Up Signal" group="Device-Wake-Up Configuration" canBeEmpty="true" visible="`${btHostWake}`" desc="Select the host pin connected to the BT_DEV_WAKE signal." />
<ParamBlock id="devWakePin" blockType="ioss\.port\.pin" name="Device-Wake-Up Signal" group="Device-Wake-Up Configuration" canBeEmpty="true" visible="`${btHostWake}`" desc="Select the host pin connected to the BT_DEV_WAKE signal. The pin must be enabled on the Pins tab to be added as an option to the pull-down menu. If left empty, the pin will be unconfigured." />
<ParamBool id="devWakeConnected" name="devWakeConnected" group="Internal" default="`${devWakePin ne &quot;&quot; &amp;&amp; btHostWake}`" visible="false" editable="false" desc="True, if DEV_WAKE is connected." />
<ParamChoice id="devWakePolarity" name="Device-Wake-Up Polarity" group="Device-Wake-Up Configuration" default="CYCFG_BT_WAKE_EVENT_ACTIVE_LOW" visible="`${devWakeConnected}`" editable="true" desc="Select the polarity for the BT_DEV_WAKE signal.">
<Entry name="Active Low" value="CYCFG_BT_WAKE_EVENT_ACTIVE_LOW" visible="true" />
Expand Down
Loading

0 comments on commit f06145d

Please sign in to comment.