csl_lcdctrl.h

来自「dsp在音频处理中的运用」· C头文件 代码 · 共 1,067 行 · 第 1/3 页

} CSL_LcdctrlObj;

/**
 * This data type is used to return the handle to the CSL of the LCD
 * controller module
 */
typedef struct CSL_LcdctrlObj *CSL_LcdctrlHandle;

/** @brief This will have the base-address information for the peripheral
 *  instance
 */
typedef struct {
	/** @brief Base-address of the configuration registers of the peripheral
	 */
	CSL_LcdctrlRegsOvly	regs;
} CSL_LcdctrlBaseAddress;


/** @brief Module specific parameters. Present implementation doesn't have
 *  any module specific parameters.
 */
typedef struct{
	/** @brief Bit mask to be used for module specific parameters.
     *  This declaration is just a place-holder for future
 	 *  implementation.
	 */
	CSL_BitMask16   flags;
} CSL_LcdctrlParam;

/**
 * @brief Module specific context information. Present implementation of LCD
 * controller module CSL doesn't have any context information.
 */
typedef struct {
	/** Context information of LCDCTRL.
     *  This declaration is just a place-holder for future
 	 *  implementation.
 	 */
    Uint16	contextInfo;
} CSL_LcdctrlContext;


/** @brief Unreserves the LCDCTRL identified by the handle.
 *
 * <b> Usage Constraints: </b>
 * Both @a CSL_lcdctrlInit() and @a CSL_lcdctrlOpen() must be called successfully
 * in that order before @a CSL_lcdctrlClose() can be called.
 *
 * @b Example:
 * @verbatim


   CSL_lcdctrlHandle hLcdctrl;
   ...
   CSL_lcdctrlClose(hLcdctrl);
   @endverbatim
 *
 * @return returns the status of the operation (see @a CSL_Status)
 *
 */
CSL_Status  CSL_lcdctrlClose
(
 CSL_LcdctrlHandle           hLcdctrl
);

/** @brief Gets the status of the different operations or the current setup
 * of LCDCTRL.
 *
 * <b> Usage Constraints: </b>
 * Both @a CSL_lcdctrlInit() and @a CSL_lcdctrlOpen() must be called successfully
 * in that order before @a csl_lcdctrlGetHwStatus() can be called. For the
 * argument type that can be @a void* casted & passed with a particular command
 * refer to @a CSL_lcdctrlHwStatusQuery
 *
 * @b Example:
 * @verbatim


    CSL_LcdctrlHandle hLcdctrl;
    CSL_Status status;
    Uint32 response = 1;
    ...

    while (!response)
    {
        status = csl_lcdctrlGetHwStatus(hLcdctrl,
                                     CSL_LCDCTRL_QUERY_CURRENTLINE,
                                     &response);
    }

    ...
    while (response)
    {
        status = csl_lcdctrlGetHwStatus(hLcdctrl,
                                     CSL_LCDCTRL_QUERY_FRAMEDONE,
                                     &response);
    }

   @endverbatim
 *
 * @return returns the status of the operation
 *
 */
CSL_Status  CSL_lcdctrlGetHwStatus
(
 CSL_LcdctrlHandle           hLcdctrl,
 CSL_LcdctrlHwStatusQuery    myQuery,
 void                      *response
);

/** @brief Controls the parameters of the LCD controller.
 *
 * Takes a command with an optional argument & implements it. This function is
 * used to carry out the different operations performed by LCDCTRL.
 *
 * <b> Usage Constraints: </b>
 * Both @a CSL_lcdctrlInit() and @a CSL_lcdctrlOpen() must be called successfully
 * in that order before @a CSL_lcdctrlHwControl() can be called. For the
 * argument type that can be @a void* casted & passed with a particular command
 * refer to @a CSL_lcdctrlHwControlCmd.
 *
 * @b Example:
 * @verbatim
     CSL_lcdctrlHandle hLcdctrl;
     CSL_Status status;
     ....
     CSL_lcdctrlHwControl ( hLcdctrl, CSL_LCDCTRL_CMD_DISABLE_SUBPANEL_DISPLAY, 0 );
     ....
   @endverbatim
 *
 * @return returns the status of the operation
 *
 */
CSL_Status  CSL_lcdctrlHwControl
(
 CSL_LcdctrlHandle           hLcdctrl,
 CSL_LcdctrlHwControlCmd     cmd,
 void                      *cmdArg
);


/** @brief Configures the LCD controller using the setup structures.
 *
 * This function is idempotent in that calling it many times is same as
 * calling it once. This function initializes the LCDCTRL
 *
 * <b> Usage Constraints: </b>
 * CSL system initialization must be successfully completed by invoking
 * @a CSL_sysInit(), @a CSL_lcdctrlInit() and @a CSL_lcdctrlOpen() before
 * calling this function. This function should be called before using any
 * of the CSL APIs
 *
 * @b Example:
 * @verbatim
   ....
   CSL_LcdctrlHwSetup lcdctrlSetup;
   ....
   CSL_lcdctrlHwSetup( hLcdctrl, &lcdctrlSetup);

   @endverbatim
 *
 * @return returns the status of the operation
 *
 */
CSL_Status  CSL_lcdctrlHwSetup
(
 CSL_LcdctrlHandle           hLcdctrl,
 CSL_LcdctrlHwSetup*         setup
);
/** @brief Peripheral specific initialization function.
 *
 * This is the peripheral specific intialization function. This function is
 * idempotent in that calling it many times is same as calling it once.
 * This function initializes the CSL data structures, and doesn't touches
 * the hardware.
 *
 * <b> Usage Constraints: </b>
 * This function should be called before using any of the CSL APIs in the LCDCTRL
 * module.
 *
 *  Note: As LCDCTRL doesn't have any context based information, currently, the function
 *  just returns CSL_SOK. User is expected to pass NULL in the function call.
 *
 * @b Example:
 * @verbatim

   ...
   if (CSL_SOK != CSL_lcdctrlInit(NULL)) {
       return;
   }
   @endverbatim
 *
 * @return returns the status of the operation
 *
 */

CSL_Status CSL_lcdctrlInit(
	/** LCDCTRL specific context information
	 */
	CSL_LcdctrlContext * pContext
	);

/** @brief Opens the instance of LCDCTRL requested.
 *
 *  The open call sets up the data structures for the particular instance of
 *  LCDCTRL device. The device can be re-opened anytime after it has been normally
 *  closed if so required. The handle returned by this call is input as an
 *  essential argument for rest of the APIs described for this module.
 *
 *  <b> Usage Constraints: </b>
 *  LCDCTRL must be successfully initialized via @a CSL_lcdctrlInit() before calling
 *  this function. Memory for the @a CSL_LcdctrlObj must be allocated outside
 *  this call. This object must be retained while usage of this peripheral.
 *
 *  @b Example:
 *  @verbatim

	  CSL_LcdctrlObj     lcdctrlObj;
	  CSL_Status       status;
 		...
	  hLcdctrl = CSL_lcdctrlOpen(&lcdctrlObj,
                          CSL_LCDCTRL,
                          NULL,
                          &status);
   @endverbatim
 *
 * @return returns a handle @a CSL_LcdctrlHandle to the requested instance of
 * LCDCTRL if the call is successful, otherwise, a @a NULL is returned.
 *
 */
CSL_LcdctrlHandle CSL_lcdctrlOpen (
    /** Pointer to the object that holds reference to the
     *  instance of LCDCTRL requested after the call
     */
    CSL_LcdctrlObj*		    pLcdctrlObj,
    /** Instance of LCDCTRL to which a handle is requested
     */
    CSL_InstNum              lcdctrlNum,
    /** Module specific parameters;
     * Currently there are none; the user should pass 'NULL'
     */
    CSL_LcdctrlParam          *pLcdctrlParam,
    /** This returns the status (success/errors) of the call.
     * Could be 'NULL' if the user does not want status information.
     */
    CSL_Status              *pStatus
	);

/** @brief Function to get the Base-address of the peripheral instance.
 *
 *  This function is used for getting the base-address of the peripheral
 *  instance. This function will be called inside the @ CSL_lcdctrlOpen()
 *  function call.
 *
 *  Note: This function is open for re-implementing if the user wants to modify
 *        the base address of the peripheral object to point to a different
 *        location and there by allow CSL initiated write/reads into peripheral
 *        MMR's go to an alternate location. Please refer the documentation for
 *        more details.
 *
 * @b Example:
 * @verbatim

      CSL_Status status;
      CSL_LcdctrlBaseAddress   baseAddress;

       ...
      status = CSL_lcdctrlGetBaseAddress(CSL_LCDCTRL_1, NULL, &baseAddress);
   @endverbatim
 *
 * @return Returns the status of the operation (see @a CSL_Status)
 *
 */

CSL_Status CSL_lcdctrlGetBaseAddress(
        /** Instance number
         */
        CSL_InstNum  		lcdctrlNum,
        /** Module specific parameters
         */
        CSL_LcdctrlParam *		pLcdctrlParam,
        /** Base address details
         */
        CSL_LcdctrlBaseAddress *	pBaseAddress
);

/** @brief This function retrieves the hardware setup parameters of
 *  LCD controller.
 *
 * <b> Usage Constraints: </b>
 * CSL initialization must be successfully completed by invoking
 * @a CSL_lcdctrlInit() and @a CSL_lcdctrlOpen() before
 * calling this function. This function should be called after invoking
 * CSL_lcdctrlHwSetup
 *
 * @b Example:
 * @verbatim
   ....
   CSL_LcdctrlHwSetup localHWSetup;
   ....
   CSL_lcdctrlGetHwSetup( hLcdctrl, &localHWSetup);

   @endverbatim
 *
 * @return returns the status of the operation
 *
 */
CSL_Status  CSL_lcdctrlGetHwSetup (
    /**< pointer to the object that holds reference to the
       * instance of LCDCTRL requested after the call */
     CSL_LcdctrlHandle           hLcdctrl,
    /**< pointer to setup structure to read LCDCTRL register state */
     CSL_LcdctrlHwSetup          *setup
     );

/** @brief This function confgures the hardware registers of
 *  LCD controller using the config structure.
 *
 * <b> Usage Constraints: </b>
 * CSL system initialization must be successfully completed by invoking
 * @a CSL_sysInit(), @a CSL_lcdctrlInit() and @a CSL_lcdctrlOpen() before
 * calling this function.
 *
 * @b Example:
 * @verbatim
   ....
   CSL_LcdctrlConfig config = CSL_LCDTRL_CONFIG_DEFAULTS;
   ....
   config.CONTROL = 0x00000080;
   config.TIMING0 = 0x05056cef;
   config.TIMING1 = 0x0505153f;
   config.TIMING2 = 0x03300011;

   CSL_lcdctrlHwSetupRaw ( hLcdctrl, &config);

   @endverbatim
 *
 * @return returns the status of the operation
 *
 */
CSL_Status  CSL_lcdctrlHwSetupRaw (
    /* pointer to the object that holds reference to the
       * instance of LCDCTRL requested after the call */
     CSL_LcdctrlHandle           hLcdctrl,
    /* pointer to config structure to configure LCDCTRL registers */
     CSL_LcdctrlConfig          *config
     );

#ifdef __cplusplus
}
#endif

#endif