Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
resources:tools-software:uc-drivers:renesas:adp5589 [24 Jul 2012 15:35] – Approved Dragos Bogdanresources:tools-software:uc-drivers:renesas:adp5589 [24 Jan 2021 17:36] (current) – Fix bad links Dragos Bogdan
Line 1: Line 1:
-====== ADP5589 - Microcontroller No-OS Driver ====== +====== ADP5589 - No-OS Driver for Renesas Microcontroller Platforms ====== 
- +{{page>:resources:tools-software:uc-drivers:adp5589}}
-===== Supported Devices ===== +
-  * [[adi>ADP5589]] +
- +
-===== Evaluation Boards ===== +
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]] +
- +
-===== Overview ===== +
- +
-The [[adi>ADP5589]] a 19 channel GPIO (General Purpose Input/Output) port expander with built-in keypad matrix decoder, programmable logic, reset logic, and PWM generator. The IC is capable of handling QWERTY size keyboards and GPIO expansion. I/O expander ICs are used in portable devices (phones, remote controls, & cameras) and non-portable applications (healthcare, industrial & instrumentation). +
- +
-I/O expanders can be used to increase the number of I/Os available to a processor or to reduce the number of I/Os required through interface connectors for front panel designs. +
- +
-{{ :resources:tools-software:uc-drivers:renesas:pmod_ioxp.jpg? |}} +
- +
-The goal of this project (Microcontroller No-OS) is to be able to provide reference projects for lower end processors, which can't run Linux, or aren't running a specific operating system, to help those customers using microcontrollers with ADI parts. Here you can find a generic driver which can be used as a base for any microcontroller platform and also specific drivers for Renesas platforms.+
  
 **HW Platform(s):** **HW Platform(s):**
 +  * [[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rl78-low-power-8-16-bit-mcus/yrdkrl78g13-yrdkrl78g13-demonstration-kit-rl78g13|Renesas Demo Kit for RL78G13 (Renesas)]]
 +  * [[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/yrdkrx62n-yrdkrx62n-demonstration-kit-rx62n|Renesas Demo Kit for RX62N (Renesas)]]
  
-  * [[http://am.renesas.com/products/tools/introductory_evaluation_tools/renesas_demo_kits/yrdkrl78g13/index.jsp|Renesas Demo Kit for RL78G13 (Renesas)]] +===== Downloads =====
-  * [[http://am.renesas.com/products/tools/introductory_evaluation_tools/renesas_demo_kits/yrdkrx62n/index.jsp|Renesas Demo Kit for RX62N (Renesas)]] +
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MX3CK|Cerebot MX3cK (Digilent)]] +
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MC7|Cerebot MC7 (Digilent)]]+
  
-===== Driver Description ===== +<WRAP round download 80%
-The driver contains two parts: +  * {{:resources:tools-software:uc-drivers:adp5589_generic.zip|ADP5589 Generic Driver}}
-  * The driver for the ADP5589 part, which may be used, without modifications, with any microcontroller. +
-  * The Communication Driver, where the specific communication functions for the desired type of processor and communication protocol have to be implemented. This driver implements the communication with the device and hides the actual details of the communication protocol to the ADI driver. +
- +
-The Communication Driver has a standard interface, so the ADP5589 driver can be used exactly as it is provided. +
- +
-There are three functions which are called by the ADP5589 driver: +
-  * I2C_Init() – initializes the communication peripheral. +
-  * I2C_Write() – writes data to the device. +
-  * I2C_Read() – reads data from the device. +
- +
-{{ :resources:tools-software:uc-drivers:renesas:i2c_architecture.png? |}} +
-<WRAP centeralign> +
-I2C driver architecture +
-</WRAP> +
- +
-The implementation of these three functions depends on the used microcontroller.  +
- +
-The following functions are implemented in this version of ADP5589 driver: +
-^ Function       ^ Description     ^ +
-| void ADP5589_SetRegisterValue(unsigned char registerAddress, unsigned char registerValue) | Writes data into a register. | +
-| unsigned char ADP5589_GetRegisterValue(unsigned char registerAddress) | Reads the value of a register. | +
-| unsigned char ADP5589_Init(void) | Initializes the communication peripheral and checks if the ADP5589 part is present. | +
-| void ADP5589_InitPwm(void) | Initializes the PWM generator in continuous mode. | +
-| void ADP5589_SetPwm(unsigned short pwmOffTime, unsigned short pwmOnTime) | Sets the PWM On and Off times. | +
-| void ADP5589_GpioDirection(unsigned char reg, unsigned char val) | Sets the direction of the pins. | +
-| unsigned char ADP5589_GetPinState(unsigned char reg) | Reads the state of the pins. | +
-| void ADP5589_InitKey(unsigned char pmodPort) | Initializes keyboard decoder. | +
-| unsigned char ADP5589_KeyDecode(unsigned char reg, unsigned char pmodPort) | Decodes the key pressed on the Pmod-KYPD. | +
-| void ADP5589_KeyLock(unsigned char pmodPort) | Locks the ADP5589 and requests Password for unlock. | +
- +
-===== Downloads ===== +
-  * {{:resources:tools-software:uc-drivers:renesas:adp5589_generic.zip|ADP5589 Generic Driver}}+
   * {{:resources:tools-software:uc-drivers:renesas:adp5589_rl78g13.zip|ADP5589 RL78G13 Driver}}   * {{:resources:tools-software:uc-drivers:renesas:adp5589_rl78g13.zip|ADP5589 RL78G13 Driver}}
   * {{:resources:tools-software:uc-drivers:renesas:adp5589_rx62n.zip|ADP5589 RX62N Driver}}   * {{:resources:tools-software:uc-drivers:renesas:adp5589_rx62n.zip|ADP5589 RX62N Driver}}
-  * {{:resources:tools-software:uc-drivers:microchip:adp5589_pic32.zip|ADP5589 PIC32 Driver}} +  * **ADP5589 Driver           ** https://github.com/analogdevicesinc/no-OS/tree/master/drivers/io-expander/adp5589 
-  * {{:resources:tools-software:uc-drivers:microchip:adp5589_dspic33.zip|ADP5589 DSPIC33 Driver}} +  * **PmodIOXP Demo for RL78G14** https://github.com/analogdevicesinc/no-OS/tree/master/Renesas/RL78G14/PmodIOXP 
 +  * **RL78G14 Common Drivers   ** https://github.com/analogdevicesinc/no-OS/tree/master/Renesas/RL78G14/Common 
 +</WRAP>
  
 ====== Renesas RL78G13 Quick Start Guide ====== ====== Renesas RL78G13 Quick Start Guide ======
Line 68: Line 21:
  
 ==== Required Hardware ==== ==== Required Hardware ====
-  * [[http://am.renesas.com/products/tools/introductory_evaluation_tools/renesas_demo_kits/yrdkrl78g13/index.jsp|Renesas Demo Kit for RL78G13 (Renesas)]]+  * [[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rl78-low-power-8-16-bit-mcus/yrdkrl78g13-yrdkrl78g13-demonstration-kit-rl78g13|Renesas Demo Kit for RL78G13 (Renesas)]]
   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]]   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]]
   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMODKYPD|PmodKYPD]]   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMODKYPD|PmodKYPD]]
Line 74: Line 27:
 ==== Required Software ==== ==== Required Software ====
   * [[http://www.iar.com/en/Products/IAR-Embedded-Workbench/Renesas-RL78/|IAR Embedded Workbench for Renesas RL78 Kickstart]]   * [[http://www.iar.com/en/Products/IAR-Embedded-Workbench/Renesas-RL78/|IAR Embedded Workbench for Renesas RL78 Kickstart]]
-  * [[http://am.renesas.com/|Applilet3 for RL78G13]] 
  
 ==== Hardware Setup ==== ==== Hardware Setup ====
Line 86: Line 38:
 {{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13.jpg? |}} {{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13.jpg? |}}
  
-==== Software Setup ==== +==== Reference Project Overview ==== 
-With the //**Applilet3 for RL78G13**// tool the following peripherals have to be configured:+The reference project: 
 +  waits for a password to unlock the keypad; 
 +   
 +{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13_screen_1.jpg? |}}
  
-=== CSI10 (Clocked Serial Interface 10) – For the ST7579 LCD part === +  * after the keypad is unlocked, it will display on the LCD the last pressed key and the status of R0 pin; also the PWM generator is enabled on pin R3
-Choose to generate the Transmit/receive function for the CSI10 and configure the interface with the following settings: +
-  * Transfer mode setting: //**Single transfer mode**// +
-  * Data length setting : //**8 bits**// +
-  * Transfer direction setting: //**MSB**// +
-  * Specification of data timing: //**Type 1**// +
-  * Transfer rate setting – Clock mode: //**Internal clock (master)**// +
-  * Transfer rate setting – Baudrate: //**1000000**// (bps) +
-  * Interrupt setting – Transfer interrupt priority (INTCSI10): //**Low**// +
-  * Uncheck the callback functions.+
  
-=== IICA0 (Inter Integrated Circuit Bus) - For the ADP5589 part === +{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13_screen_2.jpg? |}}
-Choose the //**Single master**// transfer mode and configure the interface with the following settings: +
-  * Clock mode setting//**fCLK/2**// +
-  * Local address setting – Address//**16**// +
-  * Operation mode setting : //**Standard**// +
-  * Operation mode setting – Transfer clock (fSCL): //**100000**// (bps) +
-  * Interrupt setting – Communication end interrupt priority (INTIICA0): //**Low**// +
-  * Callback function settingCheck //**Master transmission end**// and //**Master reception end**// callback functions +
-  * Callback function enhanced feature settingCheck the //**Callback function enhanced feature setting**//.+
  
-=== TM00 (Timer 00) – For the DelayMs() function ===  +==== Software Project Tutorial ==== 
-Configure TM00 as an interval timer: +{{page>rl78g13_software_tutorial_without_applilet3}} 
-  * Interval timer setting Interval value(16 bits): //**1**// ms + 
-  * Interval timer setting - Uncheck //Generates INTM00 when counting is started// +====== Renesas RL78G14 Quick Start Guide ====== 
-  * Interrupt setting - Uncheck // End of timer channel 0 count, generate an interrupt (INTM00)//+This section contains a description of the steps required to run the ADP5589 demonstration project on a Renesas RL78G14 platform using the PmodIOXP. 
 + 
 +==== Required Hardware ==== 
 +  * [[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rl78-low-power-8-16-bit-mcus/yrdkrl78g14-yrdkrl78g14-demonstration-kit-rl78g14|Renesas Demo Kit for RL78G14 (Renesas)]] 
 +  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]] 
 +  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMODKYPD|PmodKYPD]] 
 + 
 +==== Required Software ==== 
 +  * [[http://www.iar.com/en/Products/IAR-Embedded-Workbench/Renesas-RL78/|IAR Embedded Workbench for Renesas RL78 Kickstart]] 
 +  * The ADP5589 demonstration project for the Renesas RL78G14 platform.
  
-=== Watchdog Timer === +<WRAP round info 80%> 
-Disable the watchdog timer: +The ADP5589 demonstration project for the Renesas RL78G14 platform consists of three partsthe **ADP5589 Driver**,  the **PmodIOXP Demo for RL78G14** and the **RL78G14 Common Drivers**
-  Choose for the Watchdog timer operation setting: //**Unused**// option.+ 
 +All three parts have to be downloaded. 
 +</WRAP> 
 + 
 +==== Hardware Setup ==== 
 +A PmodIOXP has to be interfaced with the Renesas Demonstration Kit (RDK) for RL78G14: 
 + 
 +    PmodIOXP J3 connector 1 (SCL) → RDKRL78G14 J8  connector Pin 1 
 +    PmodIOXP J3 connector 3 (SDA) → RDKRL78G14 J8  connector Pin 3 
 +    PmodIOXP J3 connector 5 (GND) → RDKRL78G14 J11 connector Pin 5 
 +    PmodIOXP J3 connector 7 (VCC) → RDKRL78G14 J11 connector Pin 6 
 + 
 +{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g14.jpg? |}}
  
 ==== Reference Project Overview ==== ==== Reference Project Overview ====
-The reference project waits for a password to unlock the keypad.+The reference project
 +  * waits for a password to unlock the keypad
 +   
 +{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g14_screen_1.jpg? |}}
  
-{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13_screen_1.jpg? |}}+  * after the keypad is unlocked, it will display on the LCD the last pressed and released key(which can be different keys) and the status of R0 pin; also the PWM generator is enabled on pin R3
  
-After the keypad is unlocked the state of the pin R0 and the key presses are displayed on the LCD. Also the PWM generator is enabled on pin R3.+{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g14_screen_2.jpg? |}}
  
-{{ :resources:tools-software:uc-drivers:renesas:adp5589_rl78g13_screen_2.jpg? |}} 
  
 ==== Software Project Tutorial ==== ==== Software Project Tutorial ====
-{{page>rl78g13_software_tutorial}}+{{page>rl78g14_software_tutorial}} 
 + 
  
 ====== Renesas RX62N Quick Start Guide ====== ====== Renesas RX62N Quick Start Guide ======
Line 136: Line 99:
  
 ==== Required Hardware ==== ==== Required Hardware ====
-  * [[http://am.renesas.com/products/tools/introductory_evaluation_tools/renesas_demo_kits/yrdkrx62n/index.jsp|Renesas Demo Kit for RX62N (Renesas)]]+  * [[https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/yrdkrx62n-yrdkrx62n-demonstration-kit-rx62n|Renesas Demo Kit for RX62N (Renesas)]]
   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]]   * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]]
   * [[http://www.digilentinc.com/Products/Detail.cfm?NavPath=2,401,940&Prod=PMODKYPD|PmodKYPD]]   * [[http://www.digilentinc.com/Products/Detail.cfm?NavPath=2,401,940&Prod=PMODKYPD|PmodKYPD]]
 ==== Required Software ==== ==== Required Software ====
-  * [[http://www.renesas.com/products/tools/ide/ide_hew/index.jsp|High-performance Embedded Workshop for RX62N family]] +  * [[https://www.renesas.com/us/en/software-tool/high-performance-embedded-workshop|High-performance Embedded Workshop for RX62N family]] 
-  * [[http://am.renesas.com/products/tools/middleware_and_drivers/c_driver_gen/driver_gen_rpdl/index.jsp|Renesas Peripheral Driver Library for RX62N family]]+  * [[https://www.renesas.com/us/en/software-tool/renesas-peripheral-driver-library|Renesas Peripheral Driver Library for RX62N family]]
  
 ==== Hardware Setup ==== ==== Hardware Setup ====
Line 164: Line 127:
 ==== Software Project Setup ==== ==== Software Project Setup ====
 {{page>rx62n_software_design}} {{page>rx62n_software_design}}
- 
-====== Digilent Cerebot MX3cK Quick Start Guide ====== 
-This section contains a description of the steps required to run the ADP5589 demonstration project on a Digilent Cerebot MX3cK platform. 
- 
-==== Required Hardware ==== 
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MX3CK|Cerebot MX3cK (Digilent)]] 
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]] 
- 
-==== Required Software ==== 
-  * [[http://www.microchip.com/mplabx|MPLAB X Integrated Development Environment]] 
-  * [[http://www.microchip.com/mplabxc|MPLAB XC32 compiler]] 
- 
-==== Hardware Setup ==== 
-A PmodIOXP has to be connected to the J2 connector of Cerebot MX3cK development board. 
- 
-{{ :resources:tools-software:uc-drivers:microchip:pmod_ioxp_pic32.jpg? |}} 
- 
-==== Reference Project Overview ==== 
-Following commands were implemented in this version of ADP5589 reference project for Cerebot MX3cK board. 
-^ Command ^ Description ^ 
-| help? | Displays all available commands. | 
-| pwmOnTime= | On time of the PWM pulse. Accepted values: 0 - 65535 | 
-| pwmOffTime= | Off time of the PWM pulse. Accepted values: 0 - 65535 | 
-| lastKey? | Displays the last key which was pressed | 
-Commands can be executed using a serial terminal connected to the UART1 peripheral of PIC32MX320F128H. 
- 
-The following image shows a list of commands in a serial terminal connected to processor’s UART peripheral. 
-{{ :resources:tools-software:uc-drivers:microchip:terminal_pic32.png? |}} 
- 
-==== Software Project Setup ==== 
-{{page>:resources:tools-software:uc-drivers:microchip:pic32_software_design}} 
- 
-====== Digilent Cerebot MC7 Quick Start Guide ====== 
-This section contains a description of the steps required to run the ADP5589 demonstration project on a Digilent Cerebot MC7 platform. 
- 
-==== Required Hardware ==== 
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=CEREBOT-MC7|Cerebot MC7 (Digilent)]] 
-  * [[http://www.digilentinc.com/Products/Detail.cfm?Prod=PMOD-IOXP|PmodIOXP]] 
- 
-==== Required Software ==== 
-  * [[http://www.microchip.com/mplabx|MPLAB X Integrated Development Environment]] 
-  * [[http://www.microchip.com/mplabxc|MPLAB XC16 compiler]] 
- 
-==== Hardware Setup ==== 
-A PmodIOXP has to be connected to the J6 connector of Cerebot MC7 development board. 
- 
-{{ :resources:tools-software:uc-drivers:microchip:pmod_ioxp_dspic33.jpg? |}} 
- 
-==== Reference Project Overview ==== 
-Following commands were implemented in this version of ADP5589 reference project for Cerebot MC7 board. 
-^ Command ^ Description ^ 
-| help? | Displays all available commands. | 
-| pwmOnTime= | On time of the PWM pulse. Accepted values: 0 - 65535 | 
-| pwmOffTime= | Off time of the PWM pulse. Accepted values: 0 - 65535 | 
-| lastKey? | Displays the last key which was pressed | 
-Commands can be executed using a serial terminal connected to the UART1 peripheral of dsPIC33FJ128MC706A. 
- 
-The following image shows a list of commands in a serial terminal connected to processor’s UART peripheral. 
-{{ :resources:tools-software:uc-drivers:microchip:terminal_dspic33.png? |}} 
- 
-==== Software Project Setup ==== 
-{{page>:resources:tools-software:uc-drivers:microchip:dspic33_software_design}} 
  
 ====== More information ====== ====== More information ======
-{{page>more-information}}+{{page>:resources:tools-software:uc-drivers:more-information}}
resources/tools-software/uc-drivers/renesas/adp5589.1343136952.txt.gz · Last modified: 24 Jul 2012 15:35 by Dragos Bogdan