[131335]: nouveau-pm / libXNVCtrl / NVCtrlLib.h Maximize Restore History

Download this file

NVCtrlLib.h    697 lines (599 with data), 17.6 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
/*
* Copyright (c) 2008 NVIDIA, Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef __NVCTRLLIB_H
#define __NVCTRLLIB_H
#include "NVCtrl.h"
#if defined __cplusplus
extern "C" {
#endif
/*
* XNVCTRLQueryExtension -
*
* Returns True if the extension exists, returns False otherwise.
* event_basep and error_basep are the extension event and error
* bases. Currently, no extension specific errors or events are
* defined.
*/
Bool XNVCTRLQueryExtension (
Display *dpy,
int *event_basep,
int *error_basep
);
/*
* XNVCTRLQueryVersion -
*
* Returns True if the extension exists, returns False otherwise.
* major and minor are the extension's major and minor version
* numbers.
*/
Bool XNVCTRLQueryVersion (
Display *dpy,
int *major,
int *minor
);
/*
* XNVCTRLIsNvScreen
*
* Returns True is the specified screen is controlled by the NVIDIA
* driver. Returns False otherwise.
*/
Bool XNVCTRLIsNvScreen (
Display *dpy,
int screen
);
/*
* XNVCTRLQueryTargetCount -
*
* Returns True if the target type exists. Returns False otherwise.
* If XNVCTRLQueryTargetCount returns True, value will contain the
* count of existing targets on the server of the specified target
* type.
*
* Please see "Attribute Targets" in NVCtrl.h for the list of valid
* target types.
*
* Possible errors:
* BadValue - The target doesn't exist.
*/
Bool XNVCTRLQueryTargetCount (
Display *dpy,
int target_type,
int *value
);
/*
* XNVCTRLSetAttribute -
*
* Sets the attribute to the given value. The attributes and their
* possible values are listed in NVCtrl.h.
*
* Not all attributes require the display_mask parameter; see
* NVCtrl.h for details.
*
* Calling this function is equivalent to calling XNVCTRLSetTargetAttribute()
* with the target_type set to NV_CTRL_TARGET_TYPE_X_SCREEN and
* target_id set to 'screen'.
*
* Possible errors:
* BadValue - The screen or attribute doesn't exist.
* BadMatch - The NVIDIA driver is not present on that screen.
*/
void XNVCTRLSetAttribute (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
int value
);
/*
* XNVCTRLSetTargetAttribute -
*
* Sets the attribute to the given value. The attributes and their
* possible values are listed in NVCtrl.h.
*
* Not all attributes require the display_mask parameter; see
* NVCtrl.h for details.
*
* Possible errors:
* BadValue - The target or attribute doesn't exist.
* BadMatch - The NVIDIA driver is not present on that target.
*/
void XNVCTRLSetTargetAttribute (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
int value
);
/*
* XNVCTRLSetAttributeAndGetStatus -
*
* Same as XNVCTRLSetAttribute().
* In addition, XNVCTRLSetAttributeAndGetStatus() returns
* True if the operation succeeds, False otherwise.
*
*/
Bool XNVCTRLSetAttributeAndGetStatus (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
int value
);
/*
* XNVCTRLSetTargetAttributeAndGetStatus -
*
* Same as XNVCTRLSetTargetAttribute().
* In addition, XNVCTRLSetTargetAttributeAndGetStatus() returns
* True if the operation succeeds, False otherwise.
*
*/
Bool XNVCTRLSetTargetAttributeAndGetStatus (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
int value
);
/*
* XNVCTRLQueryAttribute -
*
* Returns True if the attribute exists. Returns False otherwise.
* If XNVCTRLQueryAttribute returns True, value will contain the
* value of the specified attribute.
*
* Not all attributes require the display_mask parameter; see
* NVCtrl.h for details.
*
* Calling this function is equivalent to calling
* XNVCTRLQueryTargetAttribute() with the target_type set to
* NV_CTRL_TARGET_TYPE_X_SCREEN and target_id set to 'screen'.
*
* Possible errors:
* BadValue - The screen doesn't exist.
* BadMatch - The NVIDIA driver is not present on that screen.
*/
Bool XNVCTRLQueryAttribute (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
int *value
);
/*
* XNVCTRLQueryTargetAttribute -
*
* Returns True if the attribute exists. Returns False otherwise.
* If XNVCTRLQueryTargetAttribute returns True, value will contain the
* value of the specified attribute.
*
* Not all attributes require the display_mask parameter; see
* NVCtrl.h for details.
*
* Possible errors:
* BadValue - The target doesn't exist.
* BadMatch - The NVIDIA driver does not control the target.
*/
Bool XNVCTRLQueryTargetAttribute (
Display *dpy,
int target_Type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
int *value
);
/*
* XNVCTRLQueryStringAttribute -
*
* Returns True if the attribute exists. Returns False otherwise.
* If XNVCTRLQueryStringAttribute returns True, *ptr will point to an
* allocated string containing the string attribute requested. It is
* the caller's responsibility to free the string when done.
*
* Calling this function is equivalent to calling
* XNVCTRLQueryTargetStringAttribute() with the target_type set to
* NV_CTRL_TARGET_TYPE_X_SCREEN and target_id set to 'screen'.
*
* Possible errors:
* BadValue - The screen doesn't exist.
* BadMatch - The NVIDIA driver is not present on that screen.
* BadAlloc - Insufficient resources to fulfill the request.
*/
Bool XNVCTRLQueryStringAttribute (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
char **ptr
);
/*
* XNVCTRLQueryTargetStringAttribute -
*
* Returns True if the attribute exists. Returns False otherwise.
* If XNVCTRLQueryTargetStringAttribute returns True, *ptr will point
* to an allocated string containing the string attribute requested.
* It is the caller's responsibility to free the string when done.
*
* Possible errors:
* BadValue - The target doesn't exist.
* BadMatch - The NVIDIA driver does not control the target.
* BadAlloc - Insufficient resources to fulfill the request.
*/
Bool XNVCTRLQueryTargetStringAttribute (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
char **ptr
);
/*
* XNVCTRLSetStringAttribute -
*
* Returns True if the operation succeded. Returns False otherwise.
*
* Possible X errors:
* BadValue - The screen doesn't exist.
* BadMatch - The NVIDIA driver is not present on that screen.
* BadAlloc - Insufficient resources to fulfill the request.
*/
Bool XNVCTRLSetStringAttribute (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
char *ptr
);
/*
* XNVCTRLSetTargetStringAttribute -
*
* Returns True if the operation succeded. Returns False otherwise.
*
* Possible X errors:
* BadValue - The screen doesn't exist.
* BadMatch - The NVIDIA driver is not present on that screen.
* BadAlloc - Insufficient resources to fulfill the request.
*/
Bool XNVCTRLSetTargetStringAttribute (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
char *ptr
);
/*
* XNVCTRLQueryValidAttributeValues -
*
* Returns True if the attribute exists. Returns False otherwise. If
* XNVCTRLQueryValidAttributeValues returns True, values will indicate
* the valid values for the specified attribute; see the description
* of NVCTRLAttributeValidValues in NVCtrl.h.
*
* Calling this function is equivalent to calling
* XNVCTRLQueryValidTargetAttributeValues() with the target_type set to
* NV_CTRL_TARGET_TYPE_X_SCREEN and target_id set to 'screen'.
*/
Bool XNVCTRLQueryValidAttributeValues (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
NVCTRLAttributeValidValuesRec *values
);
/*
* XNVCTRLQueryValidTargetAttributeValues -
*
* Returns True if the attribute exists. Returns False otherwise. If
* XNVCTRLQueryValidTargetAttributeValues returns True, values will indicate
* the valid values for the specified attribute.
*/
Bool XNVCTRLQueryValidTargetAttributeValues (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
NVCTRLAttributeValidValuesRec *values
);
/*
* XNVCTRLSetGvoColorConversion -
*
* Sets the color conversion matrix, offset, and scale that should be
* used for GVO (Graphic to Video Out).
*
* The Color Space Conversion data is ordered like this:
*
* colorMatrix[0][0] // r.Y
* colorMatrix[0][1] // g.Y
* colorMatrix[0][2] // b.Y
*
* colorMatrix[1][0] // r.Cr
* colorMatrix[1][1] // g.Cr
* colorMatrix[1][2] // b.Cr
*
* colorMatrix[2][0] // r.Cb
* colorMatrix[2][1] // g.Cb
* colorMatrix[2][2] // b.Cb
*
* colorOffset[0] // Y
* colorOffset[1] // Cr
* colorOffset[2] // Cb
*
* colorScale[0] // Y
* colorScale[1] // Cr
* colorScale[2] // Cb
*
* where the data is used according to the following formulae:
*
* Y = colorOffset[0] + colorScale[0] *
* (R * colorMatrix[0][0] +
* G * colorMatrix[0][1] +
* B * colorMatrix[0][2]);
*
* Cr = colorOffset[1] + colorScale[1] *
* (R * colorMatrix[1][0] +
* G * colorMatrix[1][1] +
* B * colorMatrix[1][2]);
*
* Cb = colorOffset[2] + colorScale[2] *
* (R * colorMatrix[2][0] +
* G * colorMatrix[2][1] +
* B * colorMatrix[2][2]);
*
* Possible errors:
* BadMatch - The NVIDIA driver is not present on that screen.
* BadImplementation - GVO is not available on that screen.
*/
void XNVCTRLSetGvoColorConversion (
Display *dpy,
int screen,
float colorMatrix[3][3],
float colorOffset[3],
float colorScale[3]
);
/*
* XNVCTRLQueryGvoColorConversion -
*
* Retrieves the color conversion matrix and color offset
* that are currently being used for GVO (Graphic to Video Out).
*
* The values are ordered within the arrays according to the comments
* for XNVCTRLSetGvoColorConversion().
*
* Possible errors:
* BadMatch - The NVIDIA driver is not present on that screen.
* BadImplementation - GVO is not available on that screen.
*/
Bool XNVCTRLQueryGvoColorConversion (
Display *dpy,
int screen,
float colorMatrix[3][3],
float colorOffset[3],
float colorScale[3]
);
/*
* XNVCTRLQueryBinaryData -
*
* Returns True if the attribute exists. Returns False otherwise.
* If XNVCTRLQueryBinaryData returns True, *ptr will point to an
* allocated block of memory containing the binary data attribute
* requested. It is the caller's responsibility to free the data
* when done. len will list the length of the binary data.
*
* Calling this function is equivalent to calling
* XNVCTRLQueryTargetBinaryData() with the target_type set to
* NV_CTRL_TARGET_TYPE_X_SCREEN and target_id set to 'screen'.
*
* Possible errors:
* BadValue - The screen doesn't exist.
* BadMatch - The NVIDIA driver is not present on that screen.
* BadAlloc - Insufficient resources to fulfill the request.
*/
Bool XNVCTRLQueryBinaryData (
Display *dpy,
int screen,
unsigned int display_mask,
unsigned int attribute,
unsigned char **ptr,
int *len
);
/*
* XNVCTRLQueryTargetBinaryData -
*
* Returns True if the attribute exists. Returns False otherwise.
* If XNVCTRLQueryTargetBinaryData returns True, *ptr will point to an
* allocated block of memory containing the binary data attribute
* requested. It is the caller's responsibility to free the data
* when done. len will list the length of the binary data.
*
* Possible errors:
* BadValue - The target doesn't exist.
* BadMatch - The NVIDIA driver does not control the target.
* BadAlloc - Insufficient resources to fulfill the request.
*/
Bool XNVCTRLQueryTargetBinaryData (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
unsigned char **ptr,
int *len
);
/*
* XNVCTRLStringOperation -
*
* Takes a string as input and returns a Xmalloc'ed string as output.
* Returns True on success and False on failure.
*/
Bool XNVCTRLStringOperation (
Display *dpy,
int target_type,
int target_id,
unsigned int display_mask,
unsigned int attribute,
char *pIn,
char **ppOut
);
/*
* XNVCtrlSelectNotify -
*
* This enables/disables receiving of NV-CONTROL events. The type
* specifies the type of event to enable (currently, the only
* type that can be requested per-screen with XNVCtrlSelectNotify()
* is ATTRIBUTE_CHANGED_EVENT); onoff controls whether receiving this
* type of event should be enabled (True) or disabled (False).
*
* Returns True if successful, or False if the screen is not
* controlled by the NVIDIA driver.
*/
Bool XNVCtrlSelectNotify (
Display *dpy,
int screen,
int type,
Bool onoff
);
/*
* XNVCtrlSelectTargetNotify -
*
* This enables/disables receiving of NV-CONTROL events that happen on
* the specified target. The notify_type specifies the type of event to
* enable (currently, the only type that can be requested per-target with
* XNVCtrlSelectTargetNotify() is TARGET_ATTRIBUTE_CHANGED_EVENT); onoff
* controls whether receiving this type of event should be enabled (True)
* or disabled (False).
*
* Returns True if successful, or False if the target is not
* controlled by the NVIDIA driver.
*/
Bool XNVCtrlSelectTargetNotify (
Display *dpy,
int target_type,
int target_id,
int notify_type,
Bool onoff
);
/*
* XNVCtrlEvent structure
*/
typedef struct {
int type;
unsigned long serial;
Bool send_event; /* always FALSE, we don't allow send_events */
Display *display;
Time time;
int screen;
unsigned int display_mask;
unsigned int attribute;
int value;
} XNVCtrlAttributeChangedEvent;
typedef union {
int type;
XNVCtrlAttributeChangedEvent attribute_changed;
long pad[24];
} XNVCtrlEvent;
/*
* XNVCtrlEventTarget structure
*/
typedef struct {
int type;
unsigned long serial;
Bool send_event; /* always FALSE, we don't allow send_events */
Display *display;
Time time;
int target_type;
int target_id;
unsigned int display_mask;
unsigned int attribute;
int value;
} XNVCtrlAttributeChangedEventTarget;
typedef union {
int type;
XNVCtrlAttributeChangedEventTarget attribute_changed;
long pad[24];
} XNVCtrlEventTarget;
/*
* XNVCtrlEventTargetAvailability structure
*/
typedef struct {
int type;
unsigned long serial;
Bool send_event; /* always FALSE, we don't allow send_events */
Display *display;
Time time;
int target_type;
int target_id;
unsigned int display_mask;
unsigned int attribute;
int value;
Bool availability;
} XNVCtrlAttributeChangedEventTargetAvailability;
typedef union {
int type;
XNVCtrlAttributeChangedEventTargetAvailability attribute_changed;
long pad[24];
} XNVCtrlEventTargetAvailability;
/*
* XNVCtrlStringEventTarget structure
*/
typedef struct {
int type;
unsigned long serial;
Bool send_event; /* always FALSE, we don't allow send_events */
Display *display;
Time time;
int target_type;
int target_id;
unsigned int display_mask;
unsigned int attribute;
} XNVCtrlStringAttributeChangedEventTarget;
typedef union {
int type;
XNVCtrlStringAttributeChangedEventTarget attribute_changed;
long pad[24];
} XNVCtrlStringEventTarget;
/*
* XNVCtrlBinaryEventTarget structure
*/
typedef struct {
int type;
unsigned long serial;
Bool send_event; /* always FALSE, we don't allow send_events */
Display *display;
Time time;
int target_type;
int target_id;
unsigned int display_mask;
unsigned int attribute;
} XNVCtrlBinaryAttributeChangedEventTarget;
typedef union {
int type;
XNVCtrlBinaryAttributeChangedEventTarget attribute_changed;
long pad[24];
} XNVCtrlBinaryEventTarget;
#if defined __cplusplus
} /* extern "C" */
#endif
#endif /* __NVCTRLLIB_H */