Init_USB
 
General Info
Properties
Methods



Init Code Usage

Component Index
CPU Component Index
Embedded Components
Component Categories



Component icon
Component Init_USB for HCS08
Universal Serial Bus (USB)
Component Level: Peripheral Initialization
Category: CPU Internal Peripherals-Peripheral Initialization
Properties:
(Properties are parameters of the component. Please see the Embedded Components page for more information.)
  • Component name - Name of the component.
  • Device - Selection of the USB device module.
  • Settings - Common USB module settings.
    • USB RAM address - This property determine beginning of USB RAM that will be allocated for USB module. The memory will be used for buffer descriptor table storage and buffers. The memory area allocated by this property and property USB RAM size must be excluded from RAM memory setting in Build options tab in the CPU bean.
    • USB RAM size - This property determines size of USB RAM memory used for USB module to store buffer descriptor table and buffers. See also description of USB RAM address property.
    • Voltage regulator - The property controls on-chip 3.3V USB voltage regulator.
      This item modifies the USBVREN bit in the USBCTL0 register.
    • PHY Transceiver - The property Enable/Disable the USB PHY transceiver. When disabled, USBDP and USBDN pins are high impedance .
      This item modifies the USBPHYEN bit in the USBCTL0 register.
    • Endpoint 0 - The settings for Endpoint 0
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL0 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL0 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL0 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL0 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL0 register.
    • Endpoint 1 - The settings for Endpoint 1
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL1 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL1 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL1 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL1 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL1 register.
    • Endpoint 2 - The settings for Endpoint 2
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL2 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL2 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL2 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL2 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL2 register.
    • Endpoint 3 - The settings for Endpoint 3
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL3 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL3 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL3 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL3 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL3 register.
    • Endpoint 4 - The settings for Endpoint 4
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL4 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL4 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL4 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL4 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL4 register.
    • Endpoint 5 - The settings for Endpoint 5
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL5 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL5 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL5 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL5 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL5 register.
    • Endpoint 6 - The settings for Endpoint 6
      • Endpoint control - The property defines if an endpoint is enabled and direction together with the properties Transmit and Receive enable.
        This item modifies the EPCTLDIS bit in the EPCTL6 register.
      • Receive enable - The property Enable/Disable a receive - the endpoint is enabled for OUT transfers.
        This item modifies the EPRXEN bit in the EPCTL6 register.
      • Transmit enable - The property Enable/Disable a transmit - the endpoint is enabled for IN transfers.
        This item modifies the EPTXEN bit in the EPCTL6 register.
      • Stall - The property set an indicator that the endpoint is stalled.
        This item modifies the EPSTALL bit in the EPCTL6 register.
      • Handshake - The property determines if the endpoint will perform handshaking during a transaction to the endpoint.
        This item modifies the EPHSHK bit in the EPCTL6 register.
  • Pins - Module pins/signals settings.
  • Interrupts - Interrupt settings of the module.
    • Interrupt - Interrupt vector (for information only)
    • Stall - The property enables/disables generating of STALL interrupt. The interrupt is used in device mode. and the Stall Flag is asserted when a STALL handshake is sent by the serial interface engine.
      This item modifies the STALL bit in the INTENB register
    • Resume - The property enables/disables an interrupt request when the USB bus activity is resumed.
      This item modifies the RESUME bit in the INTENB register.
    • Sleep - The property enables/disables an interrupt request when the USB module has detected constant idle on the bus for 3 ms, indicating that the USB module will enter suspend mode.
      This item modifies the SLEEP bit in the INTENB register.
    • Token complete - The property enables/disables generating of the interrupt when current transaction is complete.
      This item modifies the TOKDNE bit in the INTENB register.
    • Start-of-frame - The property enables/disables an interrupt request when a start-of-frame token is received.
      This item modifies the SOFTOK bit in the INTENB register.
    • USB Reset - The property enables/disables an interrupt request when USB module has decoded a valid USB reset.
      This item modifies the USBRST bit in the INTENB register.
    • Error - The property enables/disables an interrupt request when any of the error conditions have occurred.
      This item modifies the ERROR bit in the INTENB register.
    • Error conditions - Items inside this group enable various error interrupt sources that set common Error flag (Error must be enabled).
      • Bit stuff error - The property enables/disables an interrupt request when bit stuff error has been detected.
        This item modifies the BTSERR bit in the ERRENB register.
      • Buffer error - The property enables/disables an interrupt request if the USB module has requested a memory access to read a new buffer descriptor but has not been given the bus before the USB module needs to receive or transmit data. If processing a TX (IN endpoint) transfer this would cause a transmit data underflow condition. Or if processing an Rx (OUT endpoint) transfer this would cause a receive data overflow condition. This interrupt is also invoked if a data packet to or from the host is larger than the buffer size that is allocated in the Buffer Descriptor. In this case the data packet is truncated as it is put into buffer memory.
        This item modifies the BUFERR bit in the ERRENB register.
      • Bus turnaround error timeout - The property enables/disables an interrupt request if a bus turnaround timeout error has occurred. The USB module uses a bus turnaround timer to keep track of the amount of time elapsed between the token and data phases of a SETUP or OUT TOKEN or the data and handshake phases of an IN TOKEN. If more than 16-bit times are counted from the previous EOP before a transition from IDLE a bus turnaround timeout error will occur.
        This item modifies the BTOERR bit in the ERRENB register.
      • Data field error - The property enables/disables an interrupt request when the data field received was not an interval of 8 bits. The USB Specification specifies that the data field must be an integer number of bytes.
        This item modifies the DFN8 bit in the ERRENB register.
      • CRC16 error - The property enables/disables an interrupt request when the data packed has been rejected due to a CRC16 error.
        This item modifies the CRC16 bit in the ERRENB register.
      • CRC5 error - The property enables/disables an interrupt request when the data packed has been rejected due to a CRC5 error.
        This item modifies the CRC5 bit in the ERRENB register.
      • PID error - The property enables/disables an interrupt request when the PID check failed.
        This item modifies the PIDERR bit in the ERRENB register.
    • ISR name - Name of the interrupt service routine (ISR) invoked by this interrupt vector.
      The user code of the routine should handle all respective interrupt flags correctly. The routine must be implemented in the user code, it is not generated by Processor Expert. Find external prototypes of the ISRs in the component module header file.
  • Initialization - Initialization options of the module.
    • Call Init method - The Init method of the component may be called after power-on or reset (in initialization code) by PE.
      - yes The Init method is called by PE
      - no The Init method is not called by PE, it should be called in user s code
    • USB Module Enable - Enable USB module.
      This item modifies the USBEN bit in the CTL register.

PROCESSOR EXPERT is trademark of Freescale Semiconductor, Inc.
Copyright 1997 - 2010 Freescale Semiconductor, Inc.