Pull request #45: am263x: docs: Add release notes page for 9.0
Merge in PINDSW/motor_control_sdk from PINDSW-6551_add_release_notes_am263x to next * commit 'fecb017cb599bb7895587650f2480d87525d73e5': am263x: docs: Add release notes page for 9.0
This commit is contained in:
Dhaval Khandla
Naresh A
commit
98eb827a74
@ -8,6 +8,9 @@
|
||||
PROJECT_NAME = "AM263x Motor Control SDK"
|
||||
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/main_page/main_page.md
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/migration_guides/mcusdk_migration_guide.md
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/release_notes.md
|
||||
INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/release_notes_09_00_00.md
|
||||
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg
|
||||
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.cfg
|
||||
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/dcl/dcl.cfg
|
||||
|
||||
8
docs_src/docs/api_guide/device/am263x/release_notes.md
Normal file
8
docs_src/docs/api_guide/device/am263x/release_notes.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Release Notes {#RELEASE_NOTES_PAGE}
|
||||
|
||||
[TOC]
|
||||
|
||||
Refer the below pages for release specific information
|
||||
|
||||
- \subpage RELEASE_NOTES_09_00_00_PAGE
|
||||
|
||||
198
docs_src/docs/api_guide/device/am263x/release_notes_09_00_00.md
Normal file
198
docs_src/docs/api_guide/device/am263x/release_notes_09_00_00.md
Normal file
@ -0,0 +1,198 @@
|
||||
# Release Notes 09.00.00 {#RELEASE_NOTES_09_00_00_PAGE}
|
||||
|
||||
[TOC]
|
||||
|
||||
\attention Also refer to individual module pages for more details on each feature, unsupported features, important usage guidelines.
|
||||
|
||||
\attention For release notes of Industrial Communications SDK and MCU+ SDK, please refer to <a href="@VAR_IC_SDK_DOCS_PATH/RELEASE_NOTES_09_00_00_PAGE.html" target="_blank"> @VAR_SOC_NAME Industrial Communications SDK Release Notes 09.00.00</a> and <a href="@VAR_MCU_SDK_DOCS_PATH/RELEASE_NOTES_09_00_00_PAGE.html" target="_blank"> @VAR_SOC_NAME MCU+ SDK Release Notes 09.00.00</a> respectively.
|
||||
|
||||
\note The examples will show usage of SW modules and APIs on a specific CPU instance and OS combination. \n
|
||||
Unless noted otherwise, the SW modules would work in both FreeRTOS and NORTOS environment. \n
|
||||
Unless noted otherwise, the SW modules would work on any of the R5F's present on the SOC. \n
|
||||
Unless noted otherwise, the SW modules would work on all supported EVMs \n
|
||||
|
||||
## New in this Release
|
||||
|
||||
Feature | Module
|
||||
------------------------------------------------------------------------------------------------|-----------------------------------
|
||||
Digital Control Library | Real Time Libraries
|
||||
|
||||
## Device and Validation Information
|
||||
|
||||
SOC | Supported CPUs | EVM | Host PC
|
||||
------|-----------------|------------------------------------------------------------------------------|-----------------------------------------
|
||||
AM263x| R5F | AM263x ControlCard Revision E1 (referred to as am263x-cc in code). \n | Windows 10 64b or Ubuntu 18.04 64b
|
||||
AM263x| R5F | AM263x LaunchPad Revision E2 (referred to as am263x-lp in code) | Windows 10 64b or Ubuntu 18.04 64b
|
||||
|
||||
## Tools, Compiler and Other Open Source SW Module Information
|
||||
|
||||
Tools | Supported CPUs | Version
|
||||
------------------------|----------------|--------------------------------------------------------------
|
||||
Code Composer Studio | R5F | @VAR_CCS_VERSION_AM263X
|
||||
SysConfig | R5F | @VAR_SYSCFG_VERSION_AM263X, build @VAR_SYSCFG_BUILD_AM263X
|
||||
TI ARM CLANG | R5F | @VAR_TI_ARM_CLANG_VERSION
|
||||
FreeRTOS Kernel | R5F | @VAR_FREERTOS_KERNEL_VERSION
|
||||
|
||||
## Key Features
|
||||
|
||||
### Position Sense
|
||||
|
||||
Module | Supported CPUs | SysConfig Support | OS Support | Key features tested | Key features not tested
|
||||
-------------|----------------|-------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------
|
||||
Tamagawa | R5F | YES | FreeRTOS | Absolute position, Encoder ID, Reset, EEPROM Read, EEPROM Write, 2.5 Mbps and 5 Mbps Encoder Support | -
|
||||
|
||||
<!-- ## Fixed Issues
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> Applicable Releases
|
||||
<th> Resolution/Comments
|
||||
</tr>
|
||||
</table> -->
|
||||
|
||||
<!-- ## Known Issues
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> Applicable Releases
|
||||
<th> Workaround
|
||||
</tr>
|
||||
</table> -->
|
||||
|
||||
<!-- ## Errata
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> SDK Status
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2311
|
||||
<td> USART: Spurious DMA Interrupts
|
||||
<td> UART
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2313
|
||||
<td> GPMC: Sub-32-bit read issue with NAND and FPGA/FIFO
|
||||
<td> GPMC
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2331
|
||||
<td> CPSW: Device lockup when reading CPSW registers
|
||||
<td> CPSW, SBL
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2345
|
||||
<td> CPSW: Ethernet Packet corruption occurs if CPDMA fetches a packet which spans across memory banks
|
||||
<td> CPSW
|
||||
<td> Implemented
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2326
|
||||
<td> PCIe: MAIN_PLLx operating in fractional mode, which is required for enabling SSC, is not compliant with PCIe Refclk jitter limits
|
||||
<td> PCIe
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2312
|
||||
<td> MMCSD: HS200 and SDR104 Command Timeout Window Too Small
|
||||
<td> MMCSD
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2310
|
||||
<td> USART: Erroneous clear/trigger of timeout interrupt
|
||||
<td> UART
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2279
|
||||
<td> MCAN: Specification Update for dedicated Tx Buffers and Tx Queues configured with same Message ID
|
||||
<td> MCAN
|
||||
<td> Open
|
||||
</tr>
|
||||
<tr>
|
||||
<td> i2278
|
||||
<td> MCAN: Message Transmit order not guaranteed from dedicated Tx Buffers configured with same Message ID
|
||||
<td> MCAN
|
||||
<td> Open
|
||||
</tr>
|
||||
</table> -->
|
||||
|
||||
## Limitations
|
||||
<table>
|
||||
<tr>
|
||||
<th> ID
|
||||
<th> Head Line
|
||||
<th> Module
|
||||
<th> Reported in Release
|
||||
<th> Applicable Devices
|
||||
<th> Workaround
|
||||
</tr>
|
||||
<tr>
|
||||
<td> MCUSDK-208
|
||||
<td> gmake with -j can sometimes lock up Windows command prompt
|
||||
<td> Build
|
||||
<td> 7.3.0
|
||||
<td> AM64x, AM243x
|
||||
<td> Use bash for windows as part of git for windows or don't use -j option
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<!-- ## Upgrade and Compatibility Information {#UPGRADE_AND_COMPATIBILITY_INFORMATION_9_0_0} -->
|
||||
|
||||
<!-- \attention When migrating from MCU+ SDK, see \ref MIGRATION_GUIDES for more details -->
|
||||
|
||||
<!-- This section lists changes which could affect user applications developed using older SDK versions.
|
||||
Read this carefully to see if you need to do any changes in your existing application when migrating to this SDK version relative to
|
||||
previous SDK version. Also refer to older SDK version release notes to see changes in
|
||||
earlier SDKs. -->
|
||||
|
||||
<!-- ### Compiler Options
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Module
|
||||
<th> Affected API
|
||||
<th> Change
|
||||
<th> Additional Remarks
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
<td>
|
||||
</tr>
|
||||
</table> -->
|
||||
|
||||
<!-- ### Examples
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Module
|
||||
<th> Affected API
|
||||
<th> Change
|
||||
<th> Additional Remarks
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Drivers
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Module
|
||||
<th> Affected API
|
||||
<th> Change
|
||||
<th> Additional Remarks
|
||||
</tr>
|
||||
</table> -->
|
||||
@ -1,6 +1,12 @@
|
||||
# Migration Guide {#MIGRATION_GUIDES}
|
||||
|
||||
\cond SOC_AM64X || SOC_AM243X
|
||||
Components under Motor Control SDK were available in MCU+ SDK 7.x and 8.x releases.
|
||||
\endcond
|
||||
|
||||
\cond SOC_AM263X
|
||||
Components under Motor Control SDK were available in MCU+ SDK 8.x releases.
|
||||
\endcond
|
||||
|
||||
If you are a user of MCU+ SDK, then items listed on this page that will assist you in migration to Motor Control SDK.
|
||||
|
||||
@ -38,5 +44,7 @@ If you are a user of MCU+ SDK, then items listed on this page that will assist y
|
||||
|
||||
- Motor Control SDK also includes <a href="@VAR_IC_SDK_DOCS_PATH/index.html" target="_blank">@VAR_SOC_NAME Industrial Communications SDK</a> under `ind_comms_sdk` folder and <a href="@VAR_MCU_SDK_DOCS_PATH/index.html" target="_blank">@VAR_SOC_NAME MCU+ SDK</a> under `mcu_plus_sdk` folder.
|
||||
|
||||
\cond SOC_AM64X || SOC_AM243X
|
||||
- \ref UPGRADE_AND_COMPATIBILITY_INFORMATION_9_0_0 has details on changes which can affect migration of applications based on MCU+ SDK 08.06.00 to Motor Control SDK 09.00.00.
|
||||
\endcond
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user