dcl_adc.h 19.8 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2001
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   dcl_adc.h
 *
 * Project:
 * --------
 *   Maui
 *
 * Description:
 * ------------
 *   Header file of DCL (Driver Common Layer) for ADC.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/
#ifdef DCL_DEFINITION_STRUCT
#ifndef __DCL_ADC_H_STRUCT__
#define __DCL_ADC_H_STRUCT__

#define DCL_ADC_ERR_CHANNEL_NO  50
/*******************************************************************************
 * DCL_OPTIONS for ADC
 *******************************************************************************/
#define ADC_OPTIONS

 /*******************************************************************************
 * DCL_CONFIGURE_T for ADC
 *******************************************************************************/

#define ADC_CONFIGS

/*******************************************************************************
 * DCL_EVENT for ADC
 *******************************************************************************/
#define ADC_EVENTS

/*******************************************************************************
 * DCL_CTRL_CMD for ADC
 *******************************************************************************/
#define ADC_CMDS \
   ADC_CMD_CREATE_OBJECT, \
   ADC_CMD_MODIFY_PARAM, \
   ADC_CMD_START_MEASURE, \
   ADC_CMD_STOP_MEASURE, \
   ADC_CMD_SET_TIMER_PAGE_ALIGN, \
   ADC_CMD_REGISTER_MEASURE_CB, \
   ADC_CMD_REGISTER_COMPLETE_CB, \
   ADC_CMD_GET_CHANNEL, \
   ADC_CMD_SCHE_ID_GET_HANDLE, \
   ADC_CMD_TRANSFORM_INTO_VOLT, \
   ADC_CMD_TRANSFORM_INTO_TEMP, \
   ADC_CMD_TRANSFORM_INTO_CURR, \
   ADC_CMD_GET_SCHEDULER_PARAMETER, \
   ADC_CMD_SET_CALIBRATION_DATA, \
   ADC_CMD_READ_CALIBRATION_DATA, \
   ADC_CMD_READ_CALIBRATION_INFORM_IN_USBBOOT,	\
   ADC_CMD_SET_MULTI_CHANNEL_READ,	\
   ADC_CMD_SET_BYPASS_ZCV,	\
   ADC_CMD_GET_ZCV,	\
   ADC_CMD_SET_IGNORE_BY_TS,

#define HADC_CMDS \
   ADC_CMD_IMM_MEASURE, \
   ADC_CMD_SYNC_MEASURE, \
   ADC_CMD_TDMA_SYNC_SETUP, \
   ADC_CMD_POWER, \
   ADC_CMD_GET_DATA_2_META, \
   ADC_CMD_GET_DATA, \
   ADC_CMD_GET_META_DATA, \
   ADC_CMD_GET_MAX_PHYSICAL_CH, \
   ADC_CMD_GET_IMM_DATA_ON_BOOTING,

/*******************************************************************************
 * DCL_CTRL_DATA_T: Define the Control data structure for each module's command
 *******************************************************************************/
/* For ADC_CMD_CREATE_OBJECT command. */
typedef struct
{
   DCL_UINT32 u4Period;				// Measurement period (Uint is in Tick)
   DCL_UINT32 u4Sapid;
   module_type u1OwnerId;				// Indicate the module to for ADC driver to notify the result
   DCL_UINT8 u1AdcChannel;			// To be measured physical ADC channel
   DCL_UINT8 u1EvaluateCount;		// Measurement count
   DCL_BOOL fgSendPrimitive;		// Whether to send message to owner module or NOT
} ADC_CTRL_CREATE_OBJECT_T;

/* For ADC_CMD_MODIFY_PARAM command. */
typedef struct
{
   DCL_UINT32 u4Period;				// Measurement period (Uint is in Tick)
   DCL_UINT8 u1EvaluateCount;		// Measurement count
} ADC_CTRL_MODIFY_PARAM_T;
/* For ADC_CMD_START_MEASURE command. */
// ADC_CMD_START_MEASURE does NOT need parameters
/* For ADC_CMD_STOP_MEASURE command. */
// ADC_CMD_STOP_MEASURE does NOT need parameters
/* For ADC_CMD_IMM_MEASURE command. */
typedef struct
{
   DCL_UINT16 u2Channel;				// The channel to be measured
   DCL_UINT16 u2ADCValue;			// Measured ADC value
} ADC_CTRL_IMM_MEASURE_T;
/* For ADC_CMD_SYNC_MEASURE command. */
typedef struct
{
   DCL_UINT16 u2Channel;				// The channel to be measured
   DCL_UINT16 u2ADCValue;			// Measured ADC value
} ADC_CTRL_SYNC_MEASURE_T;
/* For ADC_CMD_TDMA_SYNC_SETUP command. */
typedef struct
{
   DCL_UINT16 u2Event0;				// Event 0
   DCL_UINT16 u2Event1;				// Event 1
} ADC_CTRL_TDMA_SYNC_SETUP_T;
/* For ADC_CMD_POWER command. */
typedef struct
{
   DCL_BOOL fgEnable;		// TRUE: Power on ADC module, FALSE: Power off ADC module
} ADC_CTRL_POWER_T;

/* For ADC_CMD_GET_DATA_2_META command. */
typedef struct
{
   DCL_UINT8 u1Channel;  //measure physical channel
   DCL_UINT16 u2MeaCount; //the counts of measurement
   DCL_UINT32 u4ADCData;  //return ADC value
} ADC_CTRL_GET_DATA_2_META_T;

/* For ADC_CMD_GET_DATA command. */
typedef struct
{
   DCL_UINT8 u1Channel;  //measure physical channel
   DCL_UINT32 u4ADCData;  //return ADC value
} ADC_CTRL_GET_DATA_T;

/* For ADC_CMD_GET_META_DATA command. */
typedef struct
{
   DCL_UINT8 u1Channel;  //measure physical channel
   DCL_UINT16 u2MeaCount; //the counts of measurement
   DCL_UINT32 u4ADCData;  //return ADC value
} ADC_CTRL_GET_META_DATA_T;

/* For ADC_CMD_GET_IMM_DATA_ON_BOOTING command. */
typedef struct
{
   DCL_UINT32 u4Channel; // Measure physical channel
   DCL_UINT32 u4MeaCount; // The counts of measurement
   DCL_UINT16 *u2ADCData; // Store ADC Value
} ADC_CTRL_GET_IMM_DATA_ON_BOOTING_T;

//ADC_CMD_SET_TIMER_PAGE_ALIGN
typedef struct
{
   DCL_BOOL fgPageAlign;  // TRUE: set stack timer page alignment
} ADC_CTRL_TIMER_ALIGN_T;

//ADC_CMD_GET_CHANNEL
typedef enum {
   DCL_VBAT_ADC_CHANNEL = 0,
   DCL_VISENSE_ADC_CHANNEL,
   DCL_VBATTMP_ADC_CHANNEL,
   DCL_BATTYPE_ADC_CHANNEL,
   DCL_VCHARGER_ADC_CHANNEL,
   DCL_PCBTMP_ADC_CHANNEL,
   DCL_AUX_ADC_CHANNEL,
   DCL_CHR_USB_ADC_CHANNEL,
   DCL_OTG_VBUS_ADC_CHANNEL,
   DCL_RFTMP_ADC_CHANNEL,
   DCL_MAX_ADC_CHANNEL
} DCL_ADC_CHANNEL_TYPE_ENUM;

typedef struct
{
   DCL_UINT8    u1AdcPhyCh;
   DCL_UINT16   u2AdcName;
} ADC_CTRL_GET_PHYSICAL_CHANNEL_T;

//ADC_CMD_TRANSFORM_INTO_VOLT
typedef struct
{
   DCL_DOUBLE   d8AdcValue;
   DCL_UINT32   u4Volt;
   DCL_UINT8    u1AdcPhyCh;
} ADC_CTRL_TRANSFORM_INTO_VOLT_T;

//ADC_CMD_TRANSFORM_INTO_TEMP
typedef struct
{
   DCL_UINT32   u4Volt;
   DCL_UINT32   u4Temp;
} ADC_CTRL_TRANSFORM_INTO_TEMP_T;

//ADC_CMD_TRANSFORM_INTO_CURR
typedef struct
{
   DCL_UINT32   u4Volt;
   DCL_UINT32   u4Curr;
} ADC_CTRL_TRANSFORM_INTO_CURR_T;

//typedef void (*PFN_DCLSADC_MEASURE_CALLBACK)(DCL_INT32 handle);
//ADC_CMD_REGISTER_MEASURE_CB
typedef struct
{
   kal_timer_func_ptr pfMeasure_cb;
} ADC_CTRL_REGISTER_MEASURE_CB_T;

typedef void (*PFN_DCLSADC_COMPLETE_CALLBACK)(DCL_INT32 handle, DCL_INT32 volt_result, DCL_DOUBLE adc_result);
typedef void (*PFN_DCLSADC_COMPLETE_MULTI_CALLBACK)(DCL_INT32 handle, DCL_INT32 *volt_array_result, DCL_DOUBLE *adc_array_result);
//ADC_CMD_REGISTER_COMPLETE_CB;
typedef struct
{
   PFN_DCLSADC_COMPLETE_CALLBACK pfComplete_cb;
} ADC_CTRL_REGISTER_COMPLETE_CB_T;

typedef struct
{
   PFN_DCLSADC_COMPLETE_MULTI_CALLBACK pfComplete_cb;
} ADC_CTRL_REGISTER_COMPLETE_MULTI_CB_T;


//ADC_CMD_GET_SCHEDULER_PARAMETER
typedef struct{
  DCL_UINT32     u4Ownerid;
  DCL_UINT32     u4Sapid;
	DCL_UINT32     u4Period;
	DCL_UINT8      u1Adc_phy_id;
	DCL_UINT8      u1Adc_logic_id;
	DCL_UINT8		   u1Evaluate_count;	/*how many to average*/
	DCL_BOOL       bSend_primitive;
	DCL_BOOL       bConti_measure;
	DCL_UINT32     u4Adc_sche_event_id;
	void (*complete)(DCL_INT32 adc_handle, DCL_INT32 volt_result, DCL_DOUBLE adc_result);/*callback for upper layer*/
}DCL_ADC_SCHEDULER_PARA_T;
typedef struct
{
   DCL_UINT32 u4Handle;
   DCL_ADC_SCHEDULER_PARA_T pPara;
} ADC_CTRL_GET_SCHEDULER_PARAMETER_T;

//ADC_CMD_GET_MAX_PHYSICAL_CH
typedef struct
{
	DCL_UINT32     u4Adc_max_ch;
} ADC_CTRL_GET_MAX_PHYSICAL_CH_T;

//ADC_CMD_SET_CALIBRATION_DATA:
typedef struct
{
	void  *ilm_ptr;
}ADC_CTRL_SET_CALIBRATION_DATA_T;

//ADC_CMD_READ_CALIBRATION_DATA
typedef struct
{
   DCL_INT32 i4ADCSlope[16]; //we do not want to include adc_hw.h here
   DCL_INT32 i4ADCOffset[16]; //use 16 instead of ADC_MAX_CHANNEL
}ADC_CTRL_READ_CALIBRATION_DATA_T;

//ADC_CMD_SCHE_ID_GET_HANDLE
typedef struct{
  DCL_UINT32     u4Handle;
   DCL_UINT32     u4Adc_sche_id;
}DCL_CTRL_SCHE_ID_GET_HANDLE_T;

typedef struct{
	DCL_UINT8      bEnable;
	DCL_UINT8     *u4ADC_ch_number;	
	DCL_UINT8     u4Adc_max_ch_number;
	PFN_DCLSADC_COMPLETE_MULTI_CALLBACK complete_multi_cb;
}DCL_MULTI_CHANNEL_PARA_T;

/* For ADC_CMD_SET_BYPASS_ZCV command. */
typedef struct
{
   DCL_UINT8      bBypassZcv;
} ADC_CTRL_SET_BYPASS_ZCV_T;

/* For ADC_CMD_SET_IGNORE_BY_TS command. */
typedef struct
{
   DCL_UINT8      ignore_by_ts;
} ADC_CTRL_SET_IGNORE_BY_TS_T;

/* For ADC_CMD_GET_ZCV command. */
typedef struct
{
   DCL_UINT32   u4Volt;
} ADC_CTRL_GET_ZCV_T;

#define ADC_CTRLS \
   ADC_CTRL_CREATE_OBJECT_T rADCCreateObj; \
   ADC_CTRL_MODIFY_PARAM_T rADCModifyParam; \
   ADC_CTRL_IMM_MEASURE_T rADCImmMeasure; \
   ADC_CTRL_SYNC_MEASURE_T rADCSyncMeasure; \
   ADC_CTRL_TDMA_SYNC_SETUP_T rADCTDMASyncSetup; \
   ADC_CTRL_POWER_T rADCPower; \
   ADC_CTRL_TIMER_ALIGN_T rADCTimerAlign; \
   ADC_CTRL_REGISTER_MEASURE_CB_T rADCRegisterMeasureCB; \
   ADC_CTRL_REGISTER_COMPLETE_CB_T rADCRegisterCompleteCB; \
   ADC_CTRL_GET_PHYSICAL_CHANNEL_T rADCGetPhyChannel; \
   DCL_CTRL_SCHE_ID_GET_HANDLE_T rADCScheIdGetHandle; \
   ADC_CTRL_TRANSFORM_INTO_VOLT_T rADCTransformVolt; \
   ADC_CTRL_TRANSFORM_INTO_TEMP_T rADCTransformTemp; \
   ADC_CTRL_TRANSFORM_INTO_CURR_T rADCTransformCurr; \
   ADC_CTRL_GET_DATA_2_META_T rADCGetData2Meta; \
   ADC_CTRL_GET_DATA_T rADCGetData; \
   ADC_CTRL_GET_META_DATA_T rADCGetMetaData; \
   ADC_CTRL_GET_SCHEDULER_PARAMETER_T rGetSchedulerPara; \
   ADC_CTRL_GET_MAX_PHYSICAL_CH_T rADCGetMaxPhyCh; \
   ADC_CTRL_SET_CALIBRATION_DATA_T rSetCalibrationData; \
   ADC_CTRL_READ_CALIBRATION_DATA_T rReadCalibrationData; \
   ADC_CTRL_GET_IMM_DATA_ON_BOOTING_T rGetImmDataOnBooting; \
   ADC_CTRL_SET_BYPASS_ZCV_T rADCSetBypassZcv; \
   ADC_CTRL_GET_ZCV_T rADCGetZcv; \
   ADC_CTRL_SET_IGNORE_BY_TS_T rADCSetIgnoreByTS; \
   DCL_MULTI_CHANNEL_PARA_T rMultiChannelPara;
#endif // #ifndef __DCL_ADC_H_STRUCT__
#endif // #ifdef DCL_DEFINITION_STRUCT   

#ifdef DCL_DEFINITION_PROTOTYPE
#ifndef __DCL_ADC_H_PROTOTYPE__
#define __DCL_ADC_H_PROTOTYPE__

/*************************************************************************
* FUNCTION
*  DclSADC_Initialize
*
* DESCRIPTION
*  This function is to initialize SW ADC module
*
* PARAMETERS
*  None
*
* RETURNS
*  STATUS_OK
*
*************************************************************************/
extern DCL_STATUS DclSADC_Initialize(void);
/*************************************************************************
* FUNCTION
*  DclSADC_Open
*
* DESCRIPTION
*  This function is to open the SW ADC module and return a handle
*
* PARAMETERS
*  dev: only valid for DCL_ADC
*  flags: no sepcial flags is needed. Please use FLAGS_NONE
*
* RETURNS
*  DCL_HANDLE_INVALID: Open failed
*  Other value: A valid handle
*
*************************************************************************/
extern DCL_HANDLE DclSADC_Open(DCL_DEV dev, DCL_FLAGS flags);
/*************************************************************************
* FUNCTION
*  DclSADC_ReadData
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclSADC_ReadData(DCL_HANDLE handle, DCL_BUFF *buff, DCL_BUFF_LEN buf_len, DCL_OPTIONS options);
/*************************************************************************
* FUNCTION
*  DclSADC_WriteData
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclSADC_WriteData(DCL_HANDLE handle, DCL_BUFF *buff, DCL_BUFF_LEN buf_len, DCL_OPTIONS options);
/*************************************************************************
* FUNCTION
*  DclSADC_Configure
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclSADC_Configure(DCL_HANDLE handle, DCL_CONFIGURE_T *configure);
/*************************************************************************
* FUNCTION
*  DclSADC_RegisterCallback
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclSADC_RegisterCallback(DCL_HANDLE handle, DCL_EVENT event, PFN_DCL_CALLBACK callback);
/*************************************************************************
* FUNCTION
*  DclSADC_Control
*
* DESCRIPTION
*  This function is to send command to control the SW ADC module.
*
* PARAMETERS
*  handle: A valid handle return by DclSADC_Open()
*  cmd: A control command for ADC module
*          1. ADC_CMD_CREATE_OBJECT: to create measurement object
*          2. ADC_CMD_MODIFY_PARAM: to change measurement parameters
*          3. ADC_CMD_START_MEASURE: to start measurement item
*          4. ADC_CMD_STOP_MEASURE: to stop measurement item
*  data: The data of the control command
*          1. ADC_CMD_CREATE_OBJECT: pointer to a ADC_CTRL_CREATE_OBJECT_T structure
*          2. ADC_CMD_MODIFY_PARAM: pointer to a ADC_CTRL_MODIFY_PARAM_T structure
*          3. ADC_CMD_START_MEASURE: a null pointer
*          4. ADC_CMD_STOP_MEASURE: a null pointer
*
* RETURNS
*  STATUS_OK: command is executed successfully.
*  STATUS_FAIL: command is failed.
*  STATUS_INVALID_CMD: It's a invalid command.
*
*************************************************************************/
extern DCL_STATUS DclSADC_Control(DCL_HANDLE handle, DCL_CTRL_CMD cmd, DCL_CTRL_DATA_T *data);
/*************************************************************************
* FUNCTION
*  DclSADC_Close
*
* DESCRIPTION
*  This function is to close the SW ADC module.
*
* PARAMETERS
*  handle: the returned handle value of DclSADC_Open
*
* RETURNS
*  STATUS_OK
*
*************************************************************************/
extern DCL_STATUS DclSADC_Close(DCL_HANDLE handle);

/*************************************************************************
* FUNCTION
*  DclHADC_Initialize
*
* DESCRIPTION
*  This function is to initialize Hardware ADC module
*
* PARAMETERS
*  None
*
* RETURNS
*  STATUS_OK
*
*************************************************************************/
extern DCL_STATUS DclHADC_Initialize(void);
/*************************************************************************
* FUNCTION
*  DclHADC_Open
*
* DESCRIPTION
*  This function is to open the Hardware ADC module and return a handle
*
* PARAMETERS
*  dev: only valid for Hardware DCL_ADC
*  flags: no sepcial flags is needed. Please use FLAGS_NONE
*
* RETURNS
*  DCL_HANDLE_INVALID: Open failed
*  Other value: A valid handle
*
*************************************************************************/
extern DCL_HANDLE DclHADC_Open(DCL_DEV dev, DCL_FLAGS flags);
/*************************************************************************
* FUNCTION
*  DclHADC_ReadData
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclHADC_ReadData(DCL_HANDLE handle, DCL_BUFF *buff, DCL_BUFF_LEN buf_len, DCL_OPTIONS options);
/*************************************************************************
* FUNCTION
*  DclHADC_WriteData
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclHADC_WriteData(DCL_HANDLE handle, DCL_BUFF *buff, DCL_BUFF_LEN buf_len, DCL_OPTIONS options);
/*************************************************************************
* FUNCTION
*  DclHADC_Configure
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclHADC_Configure(DCL_HANDLE handle, DCL_CONFIGURE_T *configure);
/*************************************************************************
* FUNCTION
*  DclHADC_RegisterCallback
*
* DESCRIPTION
*  This function is not supported for the ADC module now.
*
* PARAMETERS
*	N/A
*
* RETURNS
*	STATUS_UNSUPPORTED
*
*************************************************************************/
extern DCL_STATUS DclHADC_RegisterCallback(DCL_HANDLE handle, DCL_EVENT event, PFN_DCL_CALLBACK callback);
/*************************************************************************
* FUNCTION
*  DclHADC_Control
*
* DESCRIPTION
*  This function is to send command to control the Hardware ADC module.
*
* PARAMETERS
*  handle: A valid handle return by DclHADC_Open()
*  cmd: A control command for ADC module
*          1. ADC_CMD_IMM_MEASURE: to perform a immediate mode measurement (Register control only, not include power setting)
*          2. ADC_CMD_SYNC_MEASURE: to perform a sync mode measurement (Register control only, not include power setting)
*          3. ADC_CMD_TDMA_SYNC_SETUP: to setup TDMA sync mode parameters
*          4. ADC_CMD_POWER: to turn on/off ADC module power
*  data: The data of the control command
*          1. ADC_CMD_IMM_MEASURE: pointer to a ADC_CTRL_IMM_MEASURE_T structure
*          2. ADC_CMD_SYNC_MEASURE: pointer to a ADC_CTRL_SYNC_MEASURE_T structure
*          3. ADC_CMD_TDMA_SYNC_SETUP: pointer to a ADC_CTRL_TDMA_SYNC_SETUP_T structure
*          4. ADC_CMD_POWER: pointer to a ADC_CTRL_POWER_T structure
*
* RETURNS
*  STATUS_OK: command is executed successfully.
*  STATUS_FAIL: command is failed.
*  STATUS_INVALID_CMD: It's a invalid command.
*
*************************************************************************/
extern DCL_STATUS DclHADC_Control(DCL_HANDLE handle, DCL_CTRL_CMD cmd, DCL_CTRL_DATA_T *data);
/*************************************************************************
* FUNCTION
*  DclHADC_Close
*
* DESCRIPTION
*  This function is to close the Hardware ADC module.
*
* PARAMETERS
*  handle: the returned handle value of HDclADC_Open
*
* RETURNS
*  STATUS_OK
*
*************************************************************************/
extern DCL_STATUS DclHADC_Close(DCL_HANDLE handle);

#endif // #ifndef __DCL_ADC_H_PROTOTYPE__
#endif // #ifdef DCL_DEFINITION_PROTOTYPE