Fujitsu DTV/STB solution driver (FAPex driver) Documentation [V01L00R00]


fapex/abst_libclkpwr.h File Reference

abstraction library header file (CLKPWR driver) More...

Data Structures

struct  FAPEX_CLKPWR_PwmParamStrT

Defines

#define FAPEX_CLKPWR_ERR_BASE   (FAPEX_CLKPWR_MODULE_BASE + FAPEX_RET_ERR_BASE)
#define FAPEX_CLKPWR_ERR_BAD_PARAMETER   (FAPEX_CLKPWR_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)
#define FAPEX_CLKPWR_ERR_OUT_OF_MEMORY   (FAPEX_CLKPWR_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)
#define FAPEX_CLKPWR_WATCHDOG_MIN_VALUE   0x00001000
 minimum value
#define FAPEX_CLKPWR_WATCHDOG_MAX_VALUE   0x0FFFF000
 maximum value
#define FAPEX_CLKPWR_ARM   (0x1ULL << 0)
#define FAPEX_CLKPWR_AUDIO   (0x1ULL << 1)
#define FAPEX_CLKPWR_AUDIO_PROCESSOR   (0x1ULL << 2)
#define FAPEX_CLKPWR_AXI   (0x1ULL << 3)
#define FAPEX_CLKPWR_DDR2_SDRAM   (0x1ULL << 4)
#define FAPEX_CLKPWR_DMA   (0x1ULL << 5)
#define FAPEX_CLKPWR_ETH   (0x1ULL << 6)
#define FAPEX_CLKPWR_I2C   (0x1ULL << 7)
#define FAPEX_CLKPWR_ICC_APB_EFUSE   (0x1ULL << 8)
#define FAPEX_CLKPWR_IRQ_CONTROL   (0x1ULL << 9)
#define FAPEX_CLKPWR_GPIO   (0x1ULL << 10)
#define FAPEX_CLKPWR_SFLASH   (0x1ULL << 11)
#define FAPEX_CLKPWR_SSP   (0x1ULL << 12)
#define FAPEX_CLKPWR_TSD   (0x1ULL << 13)
#define FAPEX_CLKPWR_UART_FPC   (0x1ULL << 14)
#define FAPEX_CLKPWR_UPI   (0x1ULL << 15)
#define FAPEX_CLKPWR_USB   (0x1ULL << 16)
#define FAPEX_CLKPWR_VIDEO   (0x1ULL << 17)
#define FAPEX_CLKPWR_CRITICAL   (0x1ULL << 18)
#define FAPEX_CLKPWR_HDMAC   (0x1ULL << 19)
#define FAPEX_CLKPWR_SDIO   (0x1ULL << 20)
#define FAPEX_CLKPWR_SATA   (0x1ULL << 21)
#define FAPEX_CLKPWR_R2R   (0x1ULL << 22)
#define FAPEX_CLKPWR_OSD1   (0x1ULL << 23)
#define FAPEX_CLKPWR_OSD2   (0x1ULL << 24)
#define FAPEX_CLKPWR_OSD34   (0x1ULL << 25)
#define FAPEX_CLKPWR_CURSOR   (0x1ULL << 26)
#define FAPEX_CLKPWR_SD_SCALER   (0x1ULL << 27)
#define FAPEX_CLKPWR_ADC   (0x1ULL << 28)
#define FAPEX_CLKPWR_BLTE   (0x1ULL << 29)
#define FAPEX_CLKPWR_HDMI   (0x1ULL << 30)
#define FAPEX_CLKPWR_DAC0   (0x1ULL << 31)
#define FAPEX_CLKPWR_DAC1   (0x1ULL << 32)
#define FAPEX_CLKPWR_DAC2   (0x1ULL << 33)
#define FAPEX_CLKPWR_DAC3   (0x1ULL << 34)
#define FAPEX_CLKPWR_DAC4   (0x1ULL << 35)
#define FAPEX_CLKPWR_DAC5   (0x1ULL << 36)
#define FAPEX_CLKPWR_HD_RGB   (0x1ULL << 37)
#define FAPEX_CLKPWR_BASIC_POWER_DOWN   0x00022007
 Disables audio (also processor), tsd, video and reduces ARM speed to 162 MHz.
#define FAPEX_CLKPWR_GENERIC_POWER_DOWN   0x0003FFF7
 Additionally disables...
#define FAPEX_CLKPWR_UNIVERSAL_POWER_DOWN   0x0003FFF7
 Disables all allowed modules.
#define FAPEX_CLKPWR_BASIC_WAKE_UP   0x00022007
#define FAPEX_CLKPWR_GENERIC_WAKE_UP   0x0003FFFF
#define FAPEX_CLKPWR_UNIVERSAL_WAKE_UP   0x0001FFC3
#define FAPEX_CLKPWR_PWM_MAX_VALUE   0x000003FF
 maximum value
#define FAPEX_CLKPWR_RUNNING   0
 State after init.
#define FAPEX_CLKPWR_STAND_BY   1
 Stand by mode.
#define FAPEX_CLKPWR_PWM_INDEX_0   0
 pwm parameters for the CLKPWR driver
#define FAPEX_CLKPWR_PWM_INDEX_1   1
#define FAPEX_CLKPWR_PWM_INDEX_2   2
#define FAPEX_CLKPWR_PWM_INDEX_3   3
#define FAPEX_IOCCOM_CLKPWR_START   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 0, uint64_t)
 ioctl specific command for the CLKPWR driver
#define FAPEX_IOCCOM_CLKPWR_STOP   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 1, uint64_t)
#define FAPEX_IOCCOM_CLKPWR_GET_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 2, int32_t)
#define FAPEX_IOCCOM_CLKPWR_WATCHDOG_START   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 3, uint32_t)
#define FAPEX_IOCCOM_CLKPWR_WATCHDOG_STOP   FAPEX_IOCCOM_STOP
#define FAPEX_IOCCOM_CLKPWR_WATCHDOG_RESET   FAPEX_IOCCOM_FORCE_RESET
#define FAPEX_IOCCOM_CLKPWR_SET_PWM   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 4, FAPEX_CLKPWR_PwmParamStrT)
#define FAPEX_IOCCOM_CLKPWR_GET_PWM   _IOWR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 5, FAPEX_CLKPWR_PwmParamStrT)

Functions

FAPEXOPENRET_T FAPEX_CLKPWR_Open (FAPEXOPENARG1_T id, FAPEXOPENARG2_T flags, FAPEXOPENARG3_T argptr)
 open method. This function is called with the systemcall "open".
FAPEXRELRET_T FAPEX_CLKPWR_Close (FAPEXRELARG1_T id)
 release method. This function is called with the systemcall "close".
FAPEXIOCRET_T FAPEX_CLKPWR_Ioctl (FAPEXIOCARG1_T id, FAPEXIOCARG2_T cmd, FAPEXIOCARG3_T pArg)
 ioctl method. This function is called with the systemcall "ioctl".

Detailed Description

abstraction library header file (CLKPWR driver)

Attention:
This program is provided as is. You can redistribute it and/or modify it. Fujitsu Semiconductor Limited accepts no responsibility or liability for any errors or omissions.

Copyright (C) 2008-2010 Fujitsu Semiconductor Limited, All Rights Reserved.


Define Documentation

#define FAPEX_CLKPWR_ERR_BASE   (FAPEX_CLKPWR_MODULE_BASE + FAPEX_RET_ERR_BASE)

FAPex CLKPWR error code base value

#define FAPEX_CLKPWR_ERR_BAD_PARAMETER   (FAPEX_CLKPWR_ERR_BASE + FAPEX_ERR_BAD_PARAMETER)

Bad parameter passed.

#define FAPEX_CLKPWR_ERR_OUT_OF_MEMORY   (FAPEX_CLKPWR_ERR_BASE + FAPEX_ERR_OUT_OF_MEMORY)

Memory allocation failed.

#define FAPEX_CLKPWR_WATCHDOG_MIN_VALUE   0x00001000

minimum value

#define FAPEX_CLKPWR_WATCHDOG_MAX_VALUE   0x0FFFF000

maximum value

#define FAPEX_CLKPWR_ARM   (0x1ULL << 0)
#define FAPEX_CLKPWR_AUDIO   (0x1ULL << 1)
#define FAPEX_CLKPWR_AUDIO_PROCESSOR   (0x1ULL << 2)
#define FAPEX_CLKPWR_AXI   (0x1ULL << 3)
#define FAPEX_CLKPWR_DDR2_SDRAM   (0x1ULL << 4)
#define FAPEX_CLKPWR_DMA   (0x1ULL << 5)
#define FAPEX_CLKPWR_ETH   (0x1ULL << 6)
#define FAPEX_CLKPWR_I2C   (0x1ULL << 7)
#define FAPEX_CLKPWR_ICC_APB_EFUSE   (0x1ULL << 8)
#define FAPEX_CLKPWR_IRQ_CONTROL   (0x1ULL << 9)
#define FAPEX_CLKPWR_GPIO   (0x1ULL << 10)
#define FAPEX_CLKPWR_SFLASH   (0x1ULL << 11)
#define FAPEX_CLKPWR_SSP   (0x1ULL << 12)
#define FAPEX_CLKPWR_TSD   (0x1ULL << 13)
#define FAPEX_CLKPWR_UART_FPC   (0x1ULL << 14)
#define FAPEX_CLKPWR_UPI   (0x1ULL << 15)
#define FAPEX_CLKPWR_USB   (0x1ULL << 16)
#define FAPEX_CLKPWR_VIDEO   (0x1ULL << 17)
#define FAPEX_CLKPWR_CRITICAL   (0x1ULL << 18)
#define FAPEX_CLKPWR_HDMAC   (0x1ULL << 19)
#define FAPEX_CLKPWR_SDIO   (0x1ULL << 20)
#define FAPEX_CLKPWR_SATA   (0x1ULL << 21)
#define FAPEX_CLKPWR_R2R   (0x1ULL << 22)
#define FAPEX_CLKPWR_OSD1   (0x1ULL << 23)
#define FAPEX_CLKPWR_OSD2   (0x1ULL << 24)
#define FAPEX_CLKPWR_OSD34   (0x1ULL << 25)
#define FAPEX_CLKPWR_CURSOR   (0x1ULL << 26)
#define FAPEX_CLKPWR_SD_SCALER   (0x1ULL << 27)
#define FAPEX_CLKPWR_ADC   (0x1ULL << 28)
#define FAPEX_CLKPWR_BLTE   (0x1ULL << 29)
#define FAPEX_CLKPWR_HDMI   (0x1ULL << 30)
#define FAPEX_CLKPWR_DAC0   (0x1ULL << 31)
#define FAPEX_CLKPWR_DAC1   (0x1ULL << 32)
#define FAPEX_CLKPWR_DAC2   (0x1ULL << 33)
#define FAPEX_CLKPWR_DAC3   (0x1ULL << 34)
#define FAPEX_CLKPWR_DAC4   (0x1ULL << 35)
#define FAPEX_CLKPWR_DAC5   (0x1ULL << 36)
#define FAPEX_CLKPWR_HD_RGB   (0x1ULL << 37)
#define FAPEX_CLKPWR_BASIC_POWER_DOWN   0x00022007

Disables audio (also processor), tsd, video and reduces ARM speed to 162 MHz.

#define FAPEX_CLKPWR_GENERIC_POWER_DOWN   0x0003FFF7

Additionally disables...

#define FAPEX_CLKPWR_UNIVERSAL_POWER_DOWN   0x0003FFF7

Disables all allowed modules.

#define FAPEX_CLKPWR_BASIC_WAKE_UP   0x00022007
#define FAPEX_CLKPWR_GENERIC_WAKE_UP   0x0003FFFF
#define FAPEX_CLKPWR_UNIVERSAL_WAKE_UP   0x0001FFC3
#define FAPEX_CLKPWR_PWM_MAX_VALUE   0x000003FF

maximum value

#define FAPEX_CLKPWR_RUNNING   0

State after init.

#define FAPEX_CLKPWR_STAND_BY   1

Stand by mode.

#define FAPEX_CLKPWR_PWM_INDEX_0   0

pwm parameters for the CLKPWR driver

The related ioctl command type : FAPEX_IOCCOM_CLKPWR_GET_PWM FAPEX_IOCCOM_CLKPWR_SET_PWM

See also:
FAPEX_CLKPWR_Ioctl
#define FAPEX_CLKPWR_PWM_INDEX_1   1
#define FAPEX_CLKPWR_PWM_INDEX_2   2
#define FAPEX_CLKPWR_PWM_INDEX_3   3
#define FAPEX_IOCCOM_CLKPWR_START   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 0, uint64_t)

ioctl specific command for the CLKPWR driver

#define FAPEX_IOCCOM_CLKPWR_STOP   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 1, uint64_t)
#define FAPEX_IOCCOM_CLKPWR_GET_STATUS   _IOR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 2, int32_t)
#define FAPEX_IOCCOM_CLKPWR_WATCHDOG_START   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 3, uint32_t)
#define FAPEX_IOCCOM_CLKPWR_WATCHDOG_STOP   FAPEX_IOCCOM_STOP
#define FAPEX_IOCCOM_CLKPWR_WATCHDOG_RESET   FAPEX_IOCCOM_FORCE_RESET
#define FAPEX_IOCCOM_CLKPWR_SET_PWM   _IOW(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 4, FAPEX_CLKPWR_PwmParamStrT)
#define FAPEX_IOCCOM_CLKPWR_GET_PWM   _IOWR(FAPEX_DEV_TYPE, FAPEX_IOCCOM_NB_CLKPWR + 5, FAPEX_CLKPWR_PwmParamStrT)

Function Documentation

FAPEXOPENRET_T FAPEX_CLKPWR_Open ( FAPEXOPENARG1_T  id,
FAPEXOPENARG2_T  flags,
FAPEXOPENARG3_T  argptr 
)

open method. This function is called with the systemcall "open".

Parameters:
idThe device identifier.
flagsThis parameter indicate a open mode (read only/write only/read-write).
This implementation supports only read-write mode.
argptrargument pointer (NULL)
Return values:
>=0process OK, new file descriptor is returned.
<0process fails, its value is set to errno.
FAPEXRELRET_T FAPEX_CLKPWR_Close ( FAPEXRELARG1_T  id )

release method. This function is called with the systemcall "close".

Parameters:
idThe identifier for this descriptor.
Return values:
0process OK
<0process fails, its value is set to errno.
FAPEXIOCRET_T FAPEX_CLKPWR_Ioctl ( FAPEXIOCARG1_T  id,
FAPEXIOCARG2_T  cmd,
FAPEXIOCARG3_T  pArg 
)

ioctl method. This function is called with the systemcall "ioctl".

Parameters:
idThe identifier for this descriptor.
cmdThe ioctl command.
pArgThe pointer to the argument of the ioctl command.
Return values:
0process OK
<0process fails, its value is set to errno.

ioctl command(cmd) type:

  • FAPEX_IOCCOM_CLKPWR_GET_PWM
    Gets the pulse width modulation (PWM).
    Set pointer of int32_t data field to pArg.
    The PWM counter value (max 10bit) will be set to this field.


Copyright © 2006-2010 by Fujitsu Semiconductor Europe GmbH
Copyright © 2008-2010 by Fujitsu Semiconductor Limited

Disclaimer:
Please note that the use of this has been based on the terms and conditions of "DK Consent Letter (For Linux)" agreement between you and Fujitsu Semiconductor Limited.
The contents of this document may be revised without prior notice. Contact our sales department for confirmation. The information in this document are presented as is, no license is granted by implication or otherwise.
More...

FUJITSU sales representatives