FM201x Application Programming Guide_v1.0

FM201x Application Programming Guide Application Note v1.0 4Q 2008
Doc. Code: CY08-AN-FM201x-05 V1.0

FM201x Application Programming Guide
Application Note
APPLICATION NOTE NOTICE
FORTéMEDIA INCORPORATED AND ITS SUBSIDIARIES (FORTéMEDIA) RESERVE THE RIGHT TO MAKE CORRECTIONS, MODIFICATIONS, ENHANCEMENTS, IMPROVEMENTS, AND OTHER CHANGES TO ITS PRODUCTS AND SERVICES AT ANY TIME AND TO DISCONTINUE ANY PRODUCT OR SERVICE WITHOUT NOTICE. CUSTOMERS SHOULD OBTAIN THE LATEST RELEVANT INFORMATION BEFORE PLACING ORDERS AND SHOULD VERIFY THAT SUCH INFORMATION IS CURRENT AND COMPLETE. ALL PRODUCTS ARE SOLD SUBJECT TO FORTEMEDIA’S TERMS AND CONDITIONS OF SALE SUPPLIED AT THE TIME OF ORDER ACKNOWLEDGMENT. FORTéMEDIA ASSUMES NO LIABILITY FOR APPLICATIONS ASSISTANCE OR CUSTOMER PRODUCT DESIGN. CUSTOMERS ARE RESPONSIBLE FOR THEIR PRODUCTS AND APPLICATIONS USING FORTEMEDIA COMPONENTS. TO MINIMIZE THE RISKS ASSOCIATED WITH CUSTOMER PRODUCTS AND APPLICATIONS, CUSTOMERS SHOULD PROVIDE ADEQUATE DESIGN AND OPERATING SAFEGUARDS. FORTéMEDIA PRODUCTS ARE INTENDED FOR NEITHER LIFE SAVING NOR LIFE SUSTAINING APPLICATIONS AND FORTéMEDIA THUS, ASSUMES NO LIABILITY IN SUCH USAGES. FORTéMEDIA PRODUCTS MAY ONLY BE USED IN LIFE-SUPPORT DEVICES OR SYSTEMS WITH THE EXPRESS WRITTEN APPROVAL OF FORTéMEDIA, INC., IF A FAILURE OF SUCH COMPONENTS CAN REASONABLY BE EXPECTED TO CAUSE THE FAILURE OF THAT LIFE-SUPPORT DEVICE OR SYSTEM, OR TO AFFECT THE SAFETY OR EFFECTIVENESS OF THAT DEVICE OR SYSTEM. LIFE SUPPORT DEVICES OR SYSTEMS ARE INTENDED TO BE IMPLANTED IN THE HUMAN BODY, OR TO SUPPORT AND/OR MAINTAIN AND SUSTAIN AND/OR PROTECT HUMAN LIFE. IF THEY FAIL, IT IS REASONABLE TO ASSUME THAT THE HEALTH OF THE USER OR OTHER PERSONS MAY BE ENDANGERED. WE HEREIN DISCLAIM ANY AND ALL WARRANTIES, INCLUDING BUT NOT LIMITED TO WARRANTIES OF NON-INFRINGEMENT, REGARDING CIRCUITS, DESCRIPTIONS AND CHARTS STATED HEREIN. Fortémedia, SAM, Fortémedia and SAM logos are trademarks of Fortémedia,, Inc. All other trademarks belong to their respective companies. Copyright ? 2006-2008 Fortémedia all rights reserved.
AN v1.0, Q4, 2008
CONFIDENTIAL
2

FM201x Application Programming Guide
Application Note
Revision History
Revision 1.0 1st relase Description Date October 2008
AN v1.0, Q4, 2008
CONFIDENTIAL
3

FM201x Application Programming Guide
Application Note
Introduction
This document describes the application programming interface for Fortémedia’s FM201x full-duplex, echo cancellation and noise suppression device. In the following paragraphs, we will explain the basic communication interface protocol between the FM201x device and the Host interface. By using examples, the user will become familiar with the parameter initialization procedures and functions for the SHI with the external host.
Interface to FM201x In order for engineers to customize the functions of the FM201x, a set of parameters must be initialized in the memory of the FM201x (addresses 0x1E30 to 0x1F0F). The following block diagram provides a brief hardware description of the internal FM201x logic modules that enables communication with external host via the SHI.
FM201x
SHI interface
External Host
bit15 0x26 0x25
bit0 data port
DSP
0x1E30 to 0x1E39 parameters available at initialization
0x1E3A to 0x1E40 other misc. bit15 bit0 data memory
parameters available at run time available for users
Diagram of Interfacing to FM201x via SHI
The FM201x accepts commands from the external host through a 16-bit data port at physical address 0x25 and 0x26. The data port is transparent to external host in “write” mode – i.e. the external host either writes data or commands to the FM201x. Commands and data parameters are written to memory addresses 0x1E30 through 0x1F0F. In
AN v1.0, Q4, 2008
CONFIDENTIAL
4

FM201x Application Programming Guide
Application Note “read” mode, the external host gets data from the FM201x. The external host must provide the specific memory address of the parameters before retrieving this data from the data port (address 0x25 and 0x26). In order to communicate with the FM201x through the SHI, it requires the following three steps: (1) The first byte transmitted by external host will be the Serial Command Byte that defines the attributes of control commands. a. The length of the data (1 or 2 byte long): The data length of parameters in data memory, 0x1E30 – 0x1F0F, is 2 byte long, and the data length of data port is one byte long (0x25 and 0x26). b. The Length of address(1 or 2 bytes long): the address of parameters in the data memory located at 0x1E30 through 0x1F0F is 2 bytes long. The address of data port, 0x25 and 0x26, is one byte long. c. The type of operation (READ or WRITE) (2) Either two address bytes for accessing data memory or one address byte to access data port (this data port is for read only) (3) The rest are the data bytes (1 or 2 Bytes in length) are the commands that the external host uses to customize the FM201x. The Serial Command Byte is defined in the following format: Data length: D7 - D4: D3: D2 – D1: 10: 01: 00: D0: 1byte 0011: for accessing Data Memory 0110: for reading the data port Write/Read. 1: write, 0: read. Number of data bytes. 11: no data, 3 bytes 2 bytes 1 byte 1: two address byte for accessing Data Memory 0: one address byte for reading data port (either 0x25: low order order byte)
byte or 0x26: high
When the Serial Command Byte indicates that external host intends to read the data memory, the FM201x will retrieve this data in word format from the specified 2 byte address and stores the data in the data port (0x25 the low order byte, 0x26 the high order byte). Meanwhile an access flag will be set to 1 to hold this data in the data port until the access flag is reset. The external host must send another command to read this data from the data port (0x25 or 0x26). The access flag will be reset to 0 at the time the high order byte (0x26) is read by the external host.
Example : Read A Data Byte From FM201x Through SHI Here is an example in C to show the implementation of reading a data byte from the data memory (0x1E34) of FM201x through SHI bus. main() { // Assume SHI is a byte-access device, and the device id is ‘60’ // Start SHI, send device id, and send 2 sync byte ‘fc’ and ‘f3’ // iihost.start: initiate activity on SHI // iihost.wbyte: write a byte on SHI // iihost.wword: write a word (2 bytes) on SHI // iihost.rbyte: read a byte on SHI // iihost.stop: stop the activity on SHI
iihost.start;
iihost.wbyte({7'h60, 1'b0});
// start
// write device id
AN v1.0, Q4, 2008
CONFIDENTIAL
5

FM201x Application Programming Guide
Application Note iihost.wbyte(8'hfc); iihost.wbyte(8'hf3); iihost.wbyte(8'h37); // write sync byte 1 // write sync byte 2 // Set data in the Serial Command: read //data from data memory: 37 means 0 data // byte and 2 address byte // write addr2 (0x1E) and addr 1 (0x34)
iihost.wword(0x1E34); iihost.stop; // FM201x will retrieve the data from 0x1E34 and store // word data into 0x25: low order data byte and 0x26: high order data byte iihost.start; // start iihost.wbyte({7'h60, 1'b0}); // write device id iihost.wbyte(8'hfc); // write sync byte 1 iihost.wbyte(8'hf3); // write sync byte 2 iihost.wbyte(8'h60); // Set data in the Serial Command: read //from 0x26 iihost.wbyte(0x26); // set read address to 0x26 iihost.start; // re-start iihost.wbyte({7'h60, 1'b1}); // send device ID to read data A = iihost.rbyte(); iihost.stop; }
Initialization Mode and Run Time Mode There are two modes for the FM201x in terms of changing parameters: Initialization and Run Time. (1) Initialization: When there is a power on reset, the FM201x will set all the default parameters then grant the access right to external host by setting the semaphore flag to 1. The FM201x will go into a wait loop until the external host initializes the parameters and the semaphore flag is reset to 0, i.e. set 0x1E3A=0. The FM201x will be initialized with the values stored in memory from 0x1E30 to 0x1F0F. When the FM201x executes based on the new parameters set by external host, it goes into Run Time mode. The parameters from 0x1E30 to 0x 1E39 are for initialization setting only and no run-time changes are recommended. The values in 0x1E3A-0x1F0F can be changed at both initialization and runtime. (2) Run Time: Once FM201x is in the Run Time mode, only the parameters in address 0x1E3A to 0x1F0F are changeable.
Please refer to the document “FM201x parameter tuning guide” for the detail of arameter tuning.
AN v1.0, Q4, 2008
CONFIDENTIAL
6