aboutsummaryrefslogtreecommitdiffstats
path: root/src/gamma-linux-drm.c
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/gamma-linux-drm.c137
1 files changed, 69 insertions, 68 deletions
diff --git a/src/gamma-linux-drm.c b/src/gamma-linux-drm.c
index ec9c1fc..32e3568 100644
--- a/src/gamma-linux-drm.c
+++ b/src/gamma-linux-drm.c
@@ -53,27 +53,27 @@
/**
- * Graphics card data for the Direct Rendering Manager adjustment method
+ * Graphics card data for the Direct Rendering Manager adjustment method.
*/
typedef struct libgamma_drm_card_data
{
/**
- * File descriptor for the connection to the graphics card
+ * File descriptor for the connection to the graphics card.
*/
int fd;
/**
- * The graphics card's mode resources
+ * The graphics card's mode resources.
*/
drmModeRes* res;
/**
- * Resources for open connectors
+ * Resources for open connectors.
*/
drmModeConnector** connectors;
/**
- * Resources for open encoders
+ * Resources for open encoders.
*/
drmModeEncoder** encoders;
@@ -82,9 +82,9 @@ typedef struct libgamma_drm_card_data
/**
- * Return the capabilities of the adjustment method
+ * Return the capabilities of the adjustment method.
*
- * @param this The data structure to fill with the method's capabilities
+ * @param this The data structure to fill with the method's capabilities.
*/
void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* restrict this)
{
@@ -117,9 +117,9 @@ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* rest
/**
- * Initialise an allocated site state
+ * Initialise an allocated site state.
*
- * @param this The site state to initialise
+ * @param this The site state to initialise.
* @param site The site identifier, unless it is `NULL` it must a
* `free`:able. One the state is destroyed the library
* will attempt to free it. There you should not free
@@ -127,7 +127,7 @@ void libgamma_linux_drm_method_capabilities(libgamma_method_capabilities_t* rest
* or allocate on the stack. Note however that it will
* not be free:d if this function fails.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_site_initialise(libgamma_site_state_t* restrict this,
char* restrict site)
@@ -155,9 +155,9 @@ int libgamma_linux_drm_site_initialise(libgamma_site_state_t* restrict this,
/**
- * Release all resources held by a site state
+ * Release all resources held by a site state.
*
- * @param this The site state
+ * @param this The site state.
*/
void libgamma_linux_drm_site_destroy(libgamma_site_state_t* restrict this)
{
@@ -166,11 +166,11 @@ void libgamma_linux_drm_site_destroy(libgamma_site_state_t* restrict this)
/**
- * Restore the gamma ramps all CRTCS with a site to the system settings
+ * Restore the gamma ramps all CRTC:s with a site to the system settings.
*
- * @param this The site state
+ * @param this The site state.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_site_restore(libgamma_site_state_t* restrict this)
{
@@ -181,13 +181,13 @@ int libgamma_linux_drm_site_restore(libgamma_site_state_t* restrict this)
/**
- * Initialise an allocated partition state
+ * Initialise an allocated partition state.
*
- * @param this The partition state to initialise
- * @param site The site state for the site that the partition belongs to
- * @param partition The the index of the partition within the site
+ * @param this The partition state to initialise.
+ * @param site The site state for the site that the partition belongs to.
+ * @param partition The the index of the partition within the site.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_partition_initialise(libgamma_partition_state_t* restrict this,
libgamma_site_state_t* restrict site, size_t partition)
@@ -301,9 +301,9 @@ int libgamma_linux_drm_partition_initialise(libgamma_partition_state_t* restrict
/**
- * Release all connectors and encoders
+ * Release all connectors and encoders.
*
- * @param this The graphics card data
+ * @param this The graphics card data.
*/
static void release_connectors_and_encoders(libgamma_drm_card_data_t* restrict this)
{
@@ -325,9 +325,9 @@ static void release_connectors_and_encoders(libgamma_drm_card_data_t* restrict t
/**
- * Release all resources held by a partition state
+ * Release all resources held by a partition state.
*
- * @param this The partition state
+ * @param this The partition state.
*/
void libgamma_linux_drm_partition_destroy(libgamma_partition_state_t* restrict this)
{
@@ -342,11 +342,11 @@ void libgamma_linux_drm_partition_destroy(libgamma_partition_state_t* restrict t
/**
- * Restore the gamma ramps all CRTCS with a partition to the system settings
+ * Restore the gamma ramps all CRTC:s with a partition to the system settings.
*
- * @param this The partition state
+ * @param this The partition state.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_partition_restore(libgamma_partition_state_t* restrict this)
{
@@ -357,13 +357,13 @@ int libgamma_linux_drm_partition_restore(libgamma_partition_state_t* restrict th
/**
- * Initialise an allocated CRTC state
+ * Initialise an allocated CRTC state.
*
- * @param this The CRTC state to initialise
- * @param partition The partition state for the partition that the CRTC belongs to
- * @param crtc The the index of the CRTC within the site
+ * @param this The CRTC state to initialise.
+ * @param partition The partition state for the partition that the CRTC belongs to.
+ * @param crtc The the index of the CRTC within the site.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_crtc_initialise(libgamma_crtc_state_t* restrict this,
libgamma_partition_state_t* restrict partition, size_t crtc)
@@ -382,9 +382,9 @@ int libgamma_linux_drm_crtc_initialise(libgamma_crtc_state_t* restrict this,
/**
- * Release all resources held by a CRTC state
+ * Release all resources held by a CRTC state.
*
- * @param this The CRTC state
+ * @param this The CRTC state.
*/
void libgamma_linux_drm_crtc_destroy(libgamma_crtc_state_t* restrict this)
{
@@ -393,11 +393,11 @@ void libgamma_linux_drm_crtc_destroy(libgamma_crtc_state_t* restrict this)
/**
- * Restore the gamma ramps for a CRTC to the system settings for that CRTC
+ * Restore the gamma ramps for a CRTC to the system settings for that CRTC.
*
- * @param this The CRTC state
+ * @param this The CRTC state.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_crtc_restore(libgamma_crtc_state_t* restrict this)
{
@@ -407,11 +407,12 @@ int libgamma_linux_drm_crtc_restore(libgamma_crtc_state_t* restrict this)
/**
- * Find the connector that a CRTC belongs to
+ * Find the connector that a CRTC belongs to.
*
- * @param this The CRTC state
- * @param error Output of the error value to store of error report fields for data that requires the connector
-'* @return The CRTC's conncetor, `NULL` on error
+ * @param this The CRTC state.
+ * @param error Output of the error value to store of error report
+ * fields for data that requires the connector.
+'* @return The CRTC's conncetor, `NULL` on error.
*/
static drmModeConnector* find_connector(libgamma_crtc_state_t* restrict this, int* restrict error)
{
@@ -447,11 +448,11 @@ static drmModeConnector* find_connector(libgamma_crtc_state_t* restrict this, in
/**
- * Get the size of the gamma ramps for a CRTC
+ * Get the size of the gamma ramps for a CRTC.
*
- * @param out Instance of a data structure to fill with the information about the CRTC
- * @param crtc The state of the CRTC whose information should be read
- * @return The value stored in `out->gamma_size_error`
+ * @param out Instance of a data structure to fill with the information about the CRTC.
+ * @param crtc The state of the CRTC whose information should be read.
+ * @return The value stored in `out->gamma_size_error`.
*/
static int get_gamma_ramp_size(libgamma_crtc_information_t* restrict out, const libgamma_crtc_state_t* restrict crtc)
{
@@ -474,13 +475,13 @@ static int get_gamma_ramp_size(libgamma_crtc_information_t* restrict out, const
/**
- * Read information from the CRTC's conncetor
+ * Read information from the CRTC's conncetor.
*
- * @param crtc The state of the CRTC whose information should be read
- * @param out Instance of a data structure to fill with the information about the CRTC
- * @param connector The CRTC's connector
- * @param fields OR:ed identifiers for the information about the CRTC that should be read
- * @return Non-zero if at least on error occured
+ * @param crtc The state of the CRTC whose information should be read.
+ * @param out Instance of a data structure to fill with the information about the CRTC.
+ * @param connector The CRTC's connector.
+ * @param fields OR:ed identifiers for the information about the CRTC that should be read.
+ * @return Non-zero if at least on error occured.
*/
static int read_connector_data(libgamma_crtc_state_t* restrict crtc, libgamma_crtc_information_t* restrict out,
const drmModeConnector* restrict connector, int32_t fields)
@@ -583,12 +584,12 @@ static int read_connector_data(libgamma_crtc_state_t* restrict crtc, libgamma_cr
/**
- * Get the extended display identification data for a monitor
+ * Get the extended display identification data for a monitor.
*
- * @param crtc The CRTC state
- * @param out Instance of a data structure to fill with the information about the CRTC
- * @param connector The CRTC's connector
- * @reutnr Non-zero on error
+ * @param crtc The CRTC state.
+ * @param out Instance of a data structure to fill with the information about the CRTC.
+ * @param connector The CRTC's connector.
+ * @reutnr Non-zero on error.
*/
static int get_edid(libgamma_crtc_state_t* restrict crtc,
libgamma_crtc_information_t* restrict out, drmModeConnector* connector)
@@ -632,11 +633,11 @@ static int get_edid(libgamma_crtc_state_t* restrict crtc,
/**
- * Read information about a CRTC
+ * Read information about a CRTC.
*
- * @param this Instance of a data structure to fill with the information about the CRTC
- * @param crtc The state of the CRTC whose information should be read
- * @param fields OR:ed identifiers for the information about the CRTC that should be read
+ * @param this Instance of a data structure to fill with the information about the CRTC.
+ * @param crtc The state of the CRTC whose information should be read.
+ * @param fields OR:ed identifiers for the information about the CRTC that should be read.
* @return Zero on success, -1 on error. On error refer to the error reports in `this`.
*/
int libgamma_linux_drm_get_crtc_information(libgamma_crtc_information_t* restrict this,
@@ -714,12 +715,12 @@ int libgamma_linux_drm_get_crtc_information(libgamma_crtc_information_t* restric
/**
- * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version
+ * Get current the gamma ramps for a CRTC, 16-bit gamma-depth version.
*
- * @param this The CRTC state
- * @param ramps The gamma ramps to fill with the current values
+ * @param this The CRTC state.
+ * @param ramps The gamma ramps to fill with the current values.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this,
libgamma_gamma_ramps_t* restrict ramps)
@@ -738,12 +739,12 @@ int libgamma_linux_drm_crtc_get_gamma_ramps(libgamma_crtc_state_t* restrict this
/**
- * Set the gamma ramps for a CRTC, 16-bit gamma-depth version
+ * Set the gamma ramps for a CRTC, 16-bit gamma-depth version.
*
- * @param this The CRTC state
- * @param ramps The gamma ramps to apply
+ * @param this The CRTC state.
+ * @param ramps The gamma ramps to apply.
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library
+ * error identifier provided by this library.
*/
int libgamma_linux_drm_crtc_set_gamma_ramps(libgamma_crtc_state_t* restrict this,
libgamma_gamma_ramps_t ramps)