1Durango Release Notes
2Version 2.57.00
3Win98/WinXP/DOS/Linux
4April 5, 2003
5
6-----------------------------------------------------------------------------
7PRODUCT INFORMATION
8-----------------------------------------------------------------------------
9Durango is a graphics/video software support package designed to assist in the
10development of display drivers and embedded applications. The core of this 
11package is source code that performs most of the graphics related 
12functionality for the National Semiconductor (c) Geode family of products.  
13Development time for new software is reduced by using these routines to access
14the hardware.
15
16-----------------------------------------------------------------------------
17INSTALLATION INSTRUCTIONS
18-----------------------------------------------------------------------------
19Download the file to a directory.  Modify and include the file durango.c 
20according to the needs of the application. 
21
22-----------------------------------------------------------------------------
23REVISION HISTORY
24-----------------------------------------------------------------------------
25
2604/05/04 Version 2.57.00
27
28-----------------------------------------------------------------------------
29FUNCTIONAL CHANGES
30-----------------------------------------------------------------------------
31
32* Fixed the PLL setting for 1280x1024@70Hz and 1152x864@70Hz.
33
34=============================================================================
35
3603/30/04 Version 2.56.00
37
38-----------------------------------------------------------------------------
39FUNCTIONAL CHANGES
40-----------------------------------------------------------------------------
41
42* Updated the GX2 render code such that BLTs that involve source will work 
43  correctly even if source is not involved in the ROP.
44
45=============================================================================
46
4703/26/04 Version 2.55.00
48
49-----------------------------------------------------------------------------
50FUNCTIONAL CHANGES
51-----------------------------------------------------------------------------
52
53* Filled in all missing refresh rates in the mode table for Redcloud and Castle.
54* Added a new routine gfx_is_panel_mode_supported.
55* Added new routines gfx_set_graphics_palette and gfx_set_graphics_palette_entry
56  to support using the video palette to gamma correct graphics data.
57
58=============================================================================
59
6003/11/04 Version 2.54.00
61
62-----------------------------------------------------------------------------
63FUNCTIONAL CHANGES
64-----------------------------------------------------------------------------
65
66* Updated the video palette routines to clear the bypass both bit before
67  updating the palette.
68
69=============================================================================
70
7103/02/04 Version 2.53.00
72
73-----------------------------------------------------------------------------
74FUNCTIONAL CHANGES
75-----------------------------------------------------------------------------
76
77* Added 1152x864@60, 85, 90 and 100Hz to the mode table.
78
79=============================================================================
80
8102/07/04 Version 2.52.00
82
83-----------------------------------------------------------------------------
84FUNCTIONAL CHANGES
85-----------------------------------------------------------------------------
86
87* Updated Durango to support Castle, including a 48MHz dotref.
88* Added 90 and 100Hz modes for Redcloud.
89* Updated the PLL table to remove any pre-divides by 2.
90
91=============================================================================
92
9310/24/03 Version 2.51.08
94
95-----------------------------------------------------------------------------
96FUNCTIONAL CHANGES
97-----------------------------------------------------------------------------
98
99* Removed GX2 1.0 support from the PLL routines, gfx_set_clock_frequency and
100  gfx_get_clock_frequency.
101* Fixed a bug in gfx_set_clock_frequency, wherein the last three PLL values in
102  Durango's PLL table could never be set.
103
104=============================================================================
105
10609/22/03 Version 2.51.07
107
108-----------------------------------------------------------------------------
109FUNCTIONAL CHANGES
110-----------------------------------------------------------------------------
111
112* Changed gfx_set_video_palette and gfx_set_video_palette_entry such that calling
113  one of these routines will also configure the video hardware to route video
114  data through the DF palette RAM.  
115* Added a new routine, gfx_set_video_palette_bypass to toggle the 'Bypass Both'
116  functionality of the SC1200 and GX2 palette RAMs.
117
118=============================================================================
119
12009/02/03 Version 2.51.06
121
122-----------------------------------------------------------------------------
123FUNCTIONAL CHANGES
124-----------------------------------------------------------------------------
125
126* Added new routine gfx_get_max_video_width for SC1200 and CS5530.  This routine 
127  calculates the maximum theoretical video width based on the current display
128  mode and video clock.
129
130=============================================================================
131
13208/07/03 Version 2.51.05
133
134-----------------------------------------------------------------------------
135FUNCTIONAL CHANGES
136-----------------------------------------------------------------------------
137
138* Fixed gfx_get_core_freq for SCx2xx when the fast PCI frequency is not 33MHz.
139* Fixed gfx_get_compression_pitch to mask correct bits.
140* Changed CS5530 and SCx2xx code to always enable video in the display 
141  controller.
142* Modified GX2 PLL code to only update the PLL when the value has not already
143  been programmed.
144
145=============================================================================
146
14706/17/03 Version 2.51.04
148
149-----------------------------------------------------------------------------
150FUNCTIONAL CHANGES
151-----------------------------------------------------------------------------
152
153* Fixed code to set default gamma RAM for SCx2xx.
154
155=============================================================================
156
15706/02/03 Version 2.51.03
158
159-----------------------------------------------------------------------------
160FUNCTIONAL CHANGES
161-----------------------------------------------------------------------------
162
163* Fixed gfx_get_cursor_position for GX2 to support large display resolutions.
164* Added default gamma RAM table for SCx2xx and GX2 to correct CSC hardware.
165
166=============================================================================
167
16803/20/03 Version 2.51.02
169
170-----------------------------------------------------------------------------
171FUNCTIONAL CHANGES
172-----------------------------------------------------------------------------
173
174* Changed all preprocessor statements to conform to K and R standard.
175* Added support for 56Hz modes to all Durango routines.
176* Added missing header file to gfx_priv.h
177
178=============================================================================
179
18003/13/03 Version 2.51.01
181
182-----------------------------------------------------------------------------
183FUNCTIONAL CHANGES
184-----------------------------------------------------------------------------
185
186* Updated file headers to NSC standard headers.
187* Added routine definitions for private and local routines.
188* Minor fixes for compilation without warnings.
189* Fixed panel timings for 640x480 panels and 1024x768 panels.
190
191=============================================================================
192
19302/05/03 Version 2.49.02
194
195-----------------------------------------------------------------------------
196FUNCTIONAL CHANGES
197-----------------------------------------------------------------------------
198
199* Fixed GX2 left clipping for 4:2:0 video.
200
201=============================================================================
202
20301/29/03 Version 2.49.01
204
205-----------------------------------------------------------------------------
206FUNCTIONAL CHANGES
207-----------------------------------------------------------------------------
208
209* Removed unused variable in CS5530 video code.
210* Changed max supported pixel clock for SCx2xx to 157.5 MHz.
211
212=============================================================================
213
21401/10/03 Version 2.49.00
215
216-----------------------------------------------------------------------------
217FUNCTIONAL CHANGES
218-----------------------------------------------------------------------------
219
220* Added extra wait loop when polling for CRC completion.
221* Removed code that sets the pitch offsets for 4:2:0 video within
222  gfx_set_video_size.
223* Fixed panning code to work with any display pitch.
224* Added code to clear the PLL bypass bit when setting the dot PLL.
225* Fixed panning code so cursor never disappears when panning.
226* Changed GX2 delay loops to do a volatile register read to prevent
227  the entire delay loop from being discarded by a compiler.
228
229=============================================================================
230
23111/19/02 Version 2.47.00
232
233-----------------------------------------------------------------------------
234FUNCTIONAL CHANGES
235-----------------------------------------------------------------------------
236
237* Updated gfx2_* routines to use a signed stride.
238* SW workaround for issue #134.8 - Strange horizontal lines appearing while
239  drawing lines.
240* Implemented gfx_set_video_left_crop for CS5530
241* Updated sub carrier reset values for NTSC and PAL.
242
243=============================================================================
244
24508/29/02 Version 2.45.00
246
247-----------------------------------------------------------------------------
248FUNCTIONAL CHANGES
249-----------------------------------------------------------------------------
250
251* Modified gfx_set_cursor_position to use cursor position when panning and not adjust
252  using hotspots.
253* Added new routine gfx_get_refreshrate_from_mode.
254* Added gfx_text_blt routine.
255* Added gfx_get_tv_display_mode_frequency routine.
256* Added gfx_get_frequency_from_refreshrate routine.
257* Added gfx_set_video_cursor_enable routine.
258* Fixed Linux compilation warnings.
259* Updated modeset code to clear panning variables.
260* Added panel timings for 1600x1200 desktops.
261* Removed wait for VBlank when panning using cursor routines.
262
263=============================================================================
264
26507/12/02 Version 2.43.03
266
267-----------------------------------------------------------------------------
268FUNCTIONAL CHANGES
269-----------------------------------------------------------------------------
270
271* Modified gfx_get_display_mode to support 56 Hz modes.
272* Added support for 8K pitch when setting a true color mode above 1024x768
273* Added a byte-packed option to gfx2_mono_expand_blt
274* Fix for Carmel D2 alpha blending issue.
275* Added typecasts for proper compilation.
276* Fixed CS5535 MBIU address.
277* Added new GX2 routine, gfx2_text_blt
278* Added MSR implementations for Linux.
279* Further optimized default GX1 string macros.
280* Added new routine, gfx_set_panel_present to allow panning without adjusting panel timings.
281* Added assembly macros for 32-bit Windows applications.
282
283=============================================================================
284
28503/21/02 Version 2.41.02
286
287-----------------------------------------------------------------------------
288FUNCTIONAL CHANGES
289-----------------------------------------------------------------------------
290
291* Optimized GX2 Bitmap-to-screen BLTs by using a 2-line offscreen scratch area.
292* Fixed a bug in GX2 monochrome bitmap BLTs.
293* Fixed gfx_get_clock_frequency for GX2 2.0
294* Added 56 Hz support to gfx_get_clock_frequency
295* Changed gfx_set_compression_size to subtract header size
296* Changed gfx_get_compression_size to add header size
297
298=============================================================================
299
30003/04/02 Version 2.39.01
301
302-----------------------------------------------------------------------------
303FUNCTIONAL CHANGES
304-----------------------------------------------------------------------------
305
306* Added support for CS5535 MSRs.
307* Fixed a bug in monochrome bitmap BLTs.
308* Added support for 32-bit CRC mechanism in GX2 2.0.
309* First official GX2 release.
310* Added support for new Dot PLL mechanism in GX2 2.0
311* Added support for Carmel D1.1 and D2.
312
313=============================================================================
314
31501/24/02 Version 2.37.00
316
317-----------------------------------------------------------------------------
318FUNCTIONAL CHANGES
319-----------------------------------------------------------------------------
320
321* Changed gfx_get_clock_frequency, gfx_get_cursor_offset and gfx_get_display_offset
322  to be outside the GFX_READ_ROUTINES flag.
323* Modified the modeset code to set higher FIFO priority levels for high bandwidth
324  modes.
325* Init code no longer returns Redcloud ID when no chip detected.
326* Added fix for Redcloud 1.x rev ID
327* New GX2 PLL settings - updates to the 14 MHz table and a new 48 MHz table.
328* Optimized all bitmap-to-screen routines.  Optimizations include new macros that
329  allow correct operation in a 16-bit environment.
330* 3K cache is now assumed to be the default scratchpad configuration.
331* gfx_get_frame_buffer_size for GX2 no longer uses a VGA register.  This allows
332  correct operation even with an external VGA card present in the system.
333* Added support for 1152x864 desktop resolution on a flat panel.
334* Added 24BPP support for large display modes.
335* Modified gfx_set_video_scale such that an identity scale is now default.
336* Modified flat panel modeset code to dynamically determine the size of the mode table.
337* Added support for Carmel Rev D2.
338
339=============================================================================
340
34110/22/01 Version 2.35.01
342
343-----------------------------------------------------------------------------
344FUNCTIONAL CHANGES
345-----------------------------------------------------------------------------
346
347* New release notes format.
348* Added fix for SC1200 issue #813 (TVOut field indication is reversed.
349* Added check for invalid values in video upscale.
350* Fixed compilation warnings and run-time errors under DOS.
351* Added new macros for word I/O.
352* Optimized VSAII MSR code to used DWORD I/O.
353* Fixed SoftVG base PCI base addresses.
354* Several fixes to Redcloud API found during bringup.
355* Modified Durango to support 4-pixel video alignment for Redcloud.
356* Added the functions gfx_test_vip_overflow, gfx_get_vip_line,
357  gfx_set_decoder_luminance_filter, gfx_set_tv_YV_delya and 
358  gfx_set_tv_field_status_invert.
359* Added support for Carmel D1 revision ID.
360* Moved gfx_get_vip_base and gfx_get_vbi_pitch outside of the 
361  GXF_READ_ROUTINES flag.
362* Minor fixes to saa7114.c and gfx_set_tv-enable.
363* Added don't care option in gfx_set_vip_base.
364* Added fix for SC1200 issue #1121 (VIP FIFO bus request threshold bit 
365  is inverted.
366
367=============================================================================
368
36907/31/01 Version 2.33.02
370
371-----------------------------------------------------------------------------
372FUNCTIONAL CHANGES
373-----------------------------------------------------------------------------
374* Completed implementation of vertical downscaling support for GX2.
375* Added a method to lock the display controller timings.
376* Added support for SC1200 Rev C.
377* Small modifications to gfx_set_video_format.
378* Removed unused and unimplemented I2C functions.
379* Changes to prevent errors and compiler warnings in DOS.
380* Updated headers to include both BSD and GPL licenses.
381
382=============================================================================
383
38406/08/01 Version 2.31.00
385
386-----------------------------------------------------------------------------
387FUNCTIONAL CHANGES
388-----------------------------------------------------------------------------
389* Added new routines to manipulate vertical video downscaling on GX2.
390* Minor fixes to the function gfx_read_window_crc.
391* Implemented all init routines for GX2 except gfx_get_core_freq.
392* Added support for 27MHz reference frequency to the GX2 PLL.
393* Added new function gfx_get_softvga_active.
394* Minor changes to the function sc1200_reset_video.
395* Fixed some minor compiler warnings.
396
397=============================================================================
398
39904/25/01 Version 2.29.00
400
401-----------------------------------------------------------------------------
402FUNCTIONAL CHANGES
403-----------------------------------------------------------------------------
404* Disabled all CSC when setting an RGB video format.
405* Modified sc1200_set_video_size to add 2 to the window height.
406* Modified code to support the accelerator and cursor in pixel and line double modes.
407* Modified gfx_get_core_freq to be a dynamic API routine.
408* Added the function gfx_read_window_crc for GX2.
409* Added init routine gfx_get_graphics_register_base for GX2.
410* Added new macros to access the scratchpad RAM to support Win2K and WinME.
411* Added mew macros to access the GP registers for GX2.
412
413=============================================================================
414
41504/06/01 Version 2.27.00
416
417-----------------------------------------------------------------------------
418FUNCTIONAL CHANGES
419-----------------------------------------------------------------------------
420* Added new TV read functions:
421     gfx_get_tv_enable, gfx_get_tv_output, gfx_get_tv_display_mode,
422     gfx_get_tv_mode_count, gfx_is_tv_display_mode_supported
423* Added new function gfx_set_display_bpp.
424* Added new function gfx_get_frame_buffer_line_size.
425* Modified gfx_set_vbi_base to accept pure physical addresses instead of offsets.
426* Implemented video and display controller routines for GX2.
427* Modified some initialization routines to be dynamic.
428* Created new API extension for GX2 MSR accesses.
429* Added new icon routines for GX2.
430* Modified gfx_set_tv_display to preserve current bpp.
431* Minor modifications to gfx_set_tv_format, gfx_set_video_palette and 
432  gfx_set_video_palette entry.
433* Added support for 1152x864@75Hz
434
435=============================================================================
436
43703/12/01 Version 2.25.00
438
439-----------------------------------------------------------------------------
440FUNCTIONAL CHANGES
441-----------------------------------------------------------------------------
442* Adapted new revision format system.
443* Synchronized with NSTA Durango.  Updated support for all SC1200 features.
444* Added support for 640x400 as well as emulated VGA modes.
445* Added new routines to access single palette color entries.
446* Added new routine to return the maximum supported pixel clock.
447* Added new routine gfx_set_crt_enable to manipulate the CRT display logic.
448* Added new rendering routine gfx_color_pattern_fill.
449* Added 4:2:0 and RGB video format support for CS5530 and SC1200.
450* Modified code to allow operation under DOS.
451
452=============================================================================
453
45407/21/00 Version 2.04
455
456-----------------------------------------------------------------------------
457FUNCTIONAL CHANGES
458-----------------------------------------------------------------------------
459* Verified Xfree86 driver version 1.1.4 under Linux, and ce v2.3.
460* Merged sc1200 changes.
461* Added routines to support the query of current display mode.
462* Added functions gfx_enable_softvga, dfx_disable_softvga. 
463* Added code optimization in rendering loops to use 32 bit writes where possible.
464* Added gfx_is_mode_supported to query if given mode supported by the h/w.
465* Added Flat panel support, really testing with panel done only for 800x600.
466* Removed subtraction of 16 from gfx_set_compression_size.
467* Added version.h file to reflect the version of the durango used. 
468
469=============================================================================
470
47103/03/00 Version 2.01
472
473-----------------------------------------------------------------------------
474FUNCTIONAL CHANGES
475-----------------------------------------------------------------------------
476* Verified Xfree86 driver version 1.1 under FreeBSD and Linux.
477* Added automatic detection of BLT buffer bases in "gfx_set_bpp" routine.
478* Fixed improper setting of VGA attribute controller index register.
479* Moved "gfx_get_display_bpp" to always be included.
480* Moved "gfx_get_hactive" and "gfx_get_vactive" to always be included.
481* Clipped video source size if off bottom or right side.
482* Properly adjusted video offset if clipped on the top side.
483* Added "gfx_get_video_line_size" and "gfx_get_video_xclip" routines.
484
485=============================================================================
486
48702/21/00 Version 2.00
488
489-----------------------------------------------------------------------------
490FUNCTIONAL CHANGES
491-----------------------------------------------------------------------------
492* Added gfx_vga.c.
493* Added write to GP_BLIT_STATUS in "gfx_set_bpp" routine.
494* Verified alpha blending on SC1200.
495* Removed "gfx_set_blt_buffers" routine.
496
497=============================================================================
498
49902/09/00 Version 1.20
500
501-----------------------------------------------------------------------------
502FUNCTIONAL CHANGES
503-----------------------------------------------------------------------------
504* Verified display modes and graphics rendering on SC1200.
505* Updated PLL table for SC1200 to set modes.
506* DURANGO.C FILE CHANGE!: Modified and added compiler definitions.
507* Split gfx_disp.c file into gu1_disp.c and gu2_disp.c
508* Split gfx_rndr.c file into gu1_rndr.c and gu2_rndr.c
509* Split gfx_vid.c file into vid_5530.c, vid_1400.c, and vid_1200.c
510* Split gfx_vip.c file into vip_1400.c and vip_1200.c
511* Split gfx_tv.c file into geode_tv.c and fs451_tv.c
512* Split gfx_i2c.c file into acc_i2c.c and gpio_i2c.c.
513* Split gfx_dcdr.c file to saa7114.c 
514* Added GFX_READ_ROUTINES compiler definition.  
515* Moved routines from gfx_read.c (no longer exists) to other files.
516* Abstracted display controller access in the video overlay routines.
517* Added routines to control display compression hardware.
518
519=============================================================================
520
52101/28/00 Version 1.13
522
523-----------------------------------------------------------------------------
524FUNCTIONAL CHANGES
525-----------------------------------------------------------------------------
526* Passes randomly generated rendering tests in Darwin for GXLV.
527* Fixed bug for large bitmap to screen BLTs (greater than 64K).
528* Fixed bug for pattern fills using solid source data for plane masks.
529
530=============================================================================
531
53201/14/00 Version 1.12
533
534-----------------------------------------------------------------------------
535FUNCTIONAL CHANGES
536-----------------------------------------------------------------------------
537* Added proper use of hotspot to gfx_set_cursor_position.
538* Fixed buffer size to handle all frame buffer start address alignments.
539* Added initial version of gfx_tv.c.
540
541=============================================================================
542
54301/07/00 Version 1.11
544
545-----------------------------------------------------------------------------
546FUNCTIONAL CHANGES
547-----------------------------------------------------------------------------
548* Fixed bug with transparent BLTs (loading transparent color into BB1).
549* Added definition of gfx_color_bitmap_to_screen_blt to gfx_rtns.h.
550* Added gfx_color_bitmap_to_screen_xblt (transparent bitmap to screen).
551
552=============================================================================
553
55412/21/99 Version 1.10
555
556-----------------------------------------------------------------------------
557FUNCTIONAL CHANGES
558-----------------------------------------------------------------------------
559* Added additional video decoder routines to gfx_dcdr.c.
560* Added VBI routines to gfx_vip.c.
561* Added alpha blending routines for SC1200 to gfx_vid.c
562
563=============================================================================
564
56510/01/99 Version 1.00
566
567-----------------------------------------------------------------------------
568FUNCTIONAL CHANGES
569-----------------------------------------------------------------------------
570* Added video port, video decoder, I2C, and hardware query routines.
571* New files: gfx_vip.c, gfx_dcdr.c, gfx_i2c.c, gfx_read.c.
572
573=============================================================================
574
57508/27/99 Version 0.05
576
577-----------------------------------------------------------------------------
578FUNCTIONAL CHANGES
579-----------------------------------------------------------------------------
580* INTERFACE CHANGE: Changed "gfx_csptr[]" to "gfx_vidptr" and "gfx_vipptr".
581* Added "gfx_get_vid_register_base" and "gfx_get_vip_register_base".
582* Added initial PLL table for SC1400.
583* Verified mode set and video overlay routines work correctly on SC1400.
584* Updated initialization routines.
585* Added update of graphics engine in "gfx_set_display_pitch".
586
587=============================================================================
588
58908/20/99 Version 0.04
590
591-----------------------------------------------------------------------------
592FUNCTIONAL CHANGES
593-----------------------------------------------------------------------------
594* INTERFACE CHANGE: "gfx_load_*" routines changed to "gfx_set_*" for naming
595  consistency.  The "gfx_text_glyph" routine was removed. 
596* Added video overlay routines.
597* Added gfx_vid.c file.
598
599=============================================================================
600
60108/16/99 Version 0.03
602
603-----------------------------------------------------------------------------
604FUNCTIONAL CHANGES
605-----------------------------------------------------------------------------
606* INTERFACE CHANGE: Access to CS5530 now through separate pointer.  Project 
607  must declare and map the gfx_csptr[GFX_CSPTR_SIZE] variable.
608* Added durango.c file as template for main source file.
609* Added gfx_init.c file.
610
611=============================================================================
612
61308/04/99 Version 0.02
614
615-----------------------------------------------------------------------------
616FUNCTIONAL CHANGES
617-----------------------------------------------------------------------------
618* Additional modes in gfx_mode.h file.
619* Separated register definitions from gfx_defs.h into gfx_regs.h.
620
621=============================================================================
622
62307/30/99 Version 0.01
624
625-----------------------------------------------------------------------------
626FUNCTIONAL CHANGES
627-----------------------------------------------------------------------------
628* Initial release.
629-----------------------------------------------------------------------------
630
631