RCCE_set_frequency_divider.3 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .TH RCCE 3 2010-06-27 "RCCE MANPAGE" "RCCE Library"
  2. .SH NAME
  3. RCCE_set_frequncy_divider \- changes the frequency in the power domain of the calling UE
  4. .SH SYNOPSIS
  5. .B #include <rcce.h>
  6. .sp
  7. .BI "int RCCE_set_frequency_divider(int " Fdiv ",int" Fdiv_new );
  8. .SH DESCRIPTION
  9. .BR RCCE_set_frequency_divider()
  10. changes the frequency in the power domain of the calling UE without affecting the voltage.
  11. This function only initiates the desired change in the frequency if called by the master UE
  12. of the power domain. For other UEs, the call returns immediately with a return code of
  13. RCCE_SUCCESS. Because frequency changes are almost instantaneous, RCCE does not provide a
  14. non-blocking version to hide latency. The RCCE_set_frequency_divider() function will not
  15. allow a programmer to set a frequency divisor that results in a frequency too high for the
  16. current voltage.
  17. .TP
  18. .B Fdiv
  19. The input requested value for the frequency divisor.
  20. .TP
  21. .B Fdiv_new
  22. The new value of the frequency divisor.
  23. .SH "RETURN VALUE"
  24. Upon successful completion
  25. .BR RCCE_set_frequency_divider()
  26. returns
  27. .BR RCCE_SUCCESS .
  28. .SH ERRORS
  29. Look in
  30. .BR rcce.h
  31. for additional error codes.
  32. .SH "SEE ALSO"
  33. rcce.h(5)
  34. .SH EXAMPLE
  35. .PP
  36. To be supplied.