-- -----------------------------------------------------------------------------
-- Title: demo of usb_serial library
-- Author: Albert Faber, Copyright (c) 2009, all rights reserved.
-- Adapted-by: -
-- Compiler: >=2.4j
--
-- This file is part of jallib (http://jallib.googlecode.com)
-- Released under the BSD license (http://www.opensource.org/licenses/bsd-license.php)
--
-- Description: This application demonstratesest USB Serial library, this application
-- will emulate a RS-232 terminal device. Once the USB device has been detected by the
-- host operating system, it will create a virtual COM port. When opening this COM
-- on the host computer, using a standard terminal application, it should show a
-- welcome message, after the welcome message all input characters are echoed back
-- to the terminal application
-- --
--
-- Sources: http://www.usb.org for USB specifications
--
-- Notes: compiled with following flags
-- -loader18 -no-fuse ; when the microchip 18f bootloader is present
-- add -no-variable-reuse when debugging flags are set due to a compiler issue
-- -
-- Some instructions for use:
-- -
-- 1. Make sure you logon as administrator, or with administrator privileges,
-- on Windows XP.
-- 2. If needed convert to the correct PIC device (change include file),
-- adapt fuses fuses and speed
-- 3. Create a basic board with USB PIC device
-- 4. Compile the this file and program the hex file into the PIC.
-- 5. After a (short) while you'll get the "new hardware found" message for
-- "JALLIB Serial". Point Windows manually to the driver in the
-- driver directory xp_drivers The drivers can be found at:
-- http://groups.google.com/group/jallib/ (usb_cdc_drivers_winxp32.zip)
-- Ignore the warning that this driver doesn't have a certificate.
-- Wait for the installation to complete.
-- 6. Open the Windows Device Manager and check out the "ports" section. A new
-- communications port will be there, with a COM number.
-- 7. Open a terminal program (for example HyperTerminal) and select the COM
-- port you found in the previous step. Pick any baudrate, Windows will
-- accommodate automatically, and use 8-N-1-no for the other settings.
-- 8. Press enter and read the message. Now everything you type will be echoed
-- back.
-- 9. Have fun, adapt to your needs
--
-- ------------------------------------------------------
--
--
-- This file has been generated from:
-- * board: board_18f14k50_af.jal
-- * test : test_usb_serial.jal
--
;@jallib section chipdef
-- chip setup
include 18f14k50
-- This file is the setup for my homebrew, 18f14k50 board
-- Currently it is a bare board, with just a PIC and a couple of headers
-- A 12 MHz external crystal and 15pf caps connected to OSC1/2
-- pin 17 (Vusb) with a 220 nF capacitor to the ground
-- The connection between PC and the 18F14k50
-- +5v to power the board (don't forget 100nf decoupling cap
-- data- wire to pin 18 (D-)
-- data+ wire to pin 19 (D+)
-- ground wire to the Vss of the PIC
-- even though the external crystal is 12 MHz, the configuration is such that
-- the CPU clock is derived from the 96 Mhz PLL clock (div2), therefore set
-- target frequency to 48 MHz
pragma target clock 24_000_000
-- fuses
pragma target CPUDIV P1 -- NO_CPU_SYSTEM_CLOCK_DIVIDE
pragma target USBDIV P1 -- USB_CLOCK_COMES_DIRECTLY_FROM_THE_OSC1_OSC2_OSCILLATOR_BLOCK_NO_DIVIDE
pragma target OSC HS
pragma target PLLEN P4 -- OSCILLATOR_MULTIPLIED_BY_4
pragma target FCMEN DISABLED
pragma target IESO DISABLED
pragma target PWRTE DISABLED -- power up timer
pragma target BROWNOUT DISABLED -- no brownout detection
pragma target VOLTAGE V30 -- brown out voltage
pragma target WDT DISABLED -- no watchdog
pragma target WDTPS P32K -- watch dog saler setting
pragma target MCLR EXTERNAL -- external reset
pragma target LVP DISABLED -- no low-voltage programming
pragma target XINST ENABLED -- extended instruction set
pragma target DEBUG DISABLED -- background debugging
pragma target CP0 DISABLED -- code block 0 not protected
pragma target CP1 DISABLED -- code block 1 not protected
pragma target CPB DISABLED -- bootblock code not write protected
pragma target WRT0 DISABLED -- table writeblock 0 not protected
pragma target WRT1 DISABLED -- table write block 1 not protected
pragma target WRTB DISABLED -- bootblock not write protected
pragma target WRTC DISABLED -- config not write protected
pragma target EBTR0 DISABLED -- table read block 0 not protected
pragma target EBTR1 DISABLED -- table read block 1 not protected
pragma target EBTRB DISABLED -- boot block not protected
pragma target HFOFST ENABLED -- THE_SYSTEM_CLOCK_IS_HELD_OFF_UNTIL_THE_HFINTOSC_IS_STABLE
include delay
include usb_serial
include print
-- constants
const byte str_welcome[] = "JALLIB USB Serial Demo app\n"
-- variables
-- interrupts? No thanks
INTCON_GIE = false
-- setup the USB serial library
usb_serial_init()
var bit has_shown_welcome_msg = true
var byte ch
-- main loop
forever loop
-- poll the usb ISR function on a regular base, in order to
-- serve the USB requests
usb_serial_flush()
-- check if USB device has been configured by the HOST
if ( usb_cdc_line_status() != 0x00 ) then
if !has_shown_welcome_msg then
has_shown_welcome_msg = true
print_string( usb_serial_data, str_welcome )
end if
else
has_shown_welcome_msg = false
end if
-- check for input character
if usb_serial_read( ch ) then
-- echo input character
usb_serial_data = ch
end if
end loop