mirror of
				https://github.com/alsa-project/alsa-lib.git
				synced 2025-10-29 05:40:25 -04:00 
			
		
		
		
	doc: ucm - add sequence graphs
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
		
							parent
							
								
									0222f45d11
								
							
						
					
					
						commit
						595115758b
					
				
					 8 changed files with 192 additions and 1 deletions
				
			
		|  | @ -1 +1,9 @@ | |||
| EXTRA_DIST=wave1.gif wave2.gif | ||||
| GIT_FILES=$(wildcard *.gif) | ||||
| PUML_FILES=$(wildcard *.puml) | ||||
| SVG_FILES=$(PUML_FILES:.puml=.svg) | ||||
| EXTRA_DIST=$(GIT_FILES) $(PUML_FILES) $(SVG_FILES) | ||||
| 
 | ||||
| all: $(SVG_FILES) | ||||
| 
 | ||||
| .puml.svg: | ||||
| 	plantuml -tsvg $< | ||||
|  |  | |||
							
								
								
									
										17
									
								
								doc/pictures/ucm-seq-boot.puml
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								doc/pictures/ucm-seq-boot.puml
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,17 @@ | |||
| @startuml | ||||
| title "UCM sequence boot order (using udev and alsactl)" | ||||
| 
 | ||||
| start | ||||
| :Sound card detected (udev); | ||||
| :UCM: FixedBootSequence; | ||||
| if (Card state (/var/lib/alsa/asound.state)) then (not present) | ||||
|   :UCM: BootSequence; | ||||
| else (present) | ||||
|   :alsactl: Restore state (from asound.state); | ||||
| endif | ||||
| :Standard sound card use (with or without UCM); | ||||
| :Save sound card state (asound.state); | ||||
| :Sound card detached; | ||||
| stop | ||||
| 
 | ||||
| @enduml | ||||
							
								
								
									
										27
									
								
								doc/pictures/ucm-seq-boot.svg
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								doc/pictures/ucm-seq-boot.svg
									
										
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| After Width: | Height: | Size: 7.2 KiB | 
							
								
								
									
										26
									
								
								doc/pictures/ucm-seq-device.puml
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								doc/pictures/ucm-seq-device.puml
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,26 @@ | |||
| @startuml | ||||
| title "UCM device sequence graph" | ||||
| 
 | ||||
| start | ||||
| split | ||||
|   :Enable device; | ||||
|   :EnableSequence; | ||||
|   :Use device; | ||||
|   :Disable device; | ||||
|   :DisableSequence; | ||||
| split again | ||||
|   :Switch device; | ||||
|   :Disable old device; | ||||
|   if (TransitionSequence) then (present) | ||||
|     :TransitionSequence; | ||||
|     :Enable new device; | ||||
|   else (not present) | ||||
|     :Disable old device; | ||||
|     :DisableSequence; | ||||
|     :Enable new device; | ||||
|     :EnableSequence; | ||||
|   endif | ||||
| end split | ||||
| stop | ||||
| 
 | ||||
| @enduml | ||||
							
								
								
									
										36
									
								
								doc/pictures/ucm-seq-device.svg
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								doc/pictures/ucm-seq-device.svg
									
										
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| After Width: | Height: | Size: 11 KiB | 
							
								
								
									
										30
									
								
								doc/pictures/ucm-seq-verb.puml
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										30
									
								
								doc/pictures/ucm-seq-verb.puml
									
										
									
									
									
										Normal file
									
								
							|  | @ -0,0 +1,30 @@ | |||
| @startuml | ||||
| title "UCM verb sequence graph" | ||||
| 
 | ||||
| 
 | ||||
| start | ||||
| split | ||||
|   :Enable verb; | ||||
|   :SectionDefaults sequence; | ||||
|   :EnableSequence; | ||||
| 
 | ||||
|   :Enable, use and disable verb devices; | ||||
| 
 | ||||
|   :Disable verb; | ||||
|   :DisableSequence; | ||||
| split again | ||||
|   :Switch verb; | ||||
|   :Disable old verb; | ||||
|   if (TransitionSequence) then (present) | ||||
|     :TransitionSequence; | ||||
|     :Enable new verb; | ||||
|   else (not present) | ||||
|     :Disable old verb; | ||||
|     :DisableSequence; | ||||
|     :Enable new verb; | ||||
|     :EnableSequence; | ||||
|   endif | ||||
| end split | ||||
| stop | ||||
| 
 | ||||
| @enduml | ||||
							
								
								
									
										40
									
								
								doc/pictures/ucm-seq-verb.svg
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								doc/pictures/ucm-seq-verb.svg
									
										
									
									
									
										Normal file
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							| After Width: | Height: | Size: 11 KiB | 
|  | @ -218,6 +218,11 @@ SectionModifier."Capture Voice" { | |||
| } | ||||
| ~~~ | ||||
| 
 | ||||
| ### Sequence graphs | ||||
| 
 | ||||
| \image html ucm-seq-verb.svg | ||||
| \image html ucm-seq-device.svg | ||||
| 
 | ||||
| ### Sequence commands | ||||
| 
 | ||||
| Command name   | Description | ||||
|  | @ -278,6 +283,8 @@ configuration like volumes or switches. The alsactl ensures the persistency (sto | |||
| the state of the controls to the /var tree and loads the previous state in the next | ||||
| boot). | ||||
| 
 | ||||
| \image html ucm-seq-boot.svg | ||||
| 
 | ||||
| ### Device volume | ||||
| 
 | ||||
| It is expected that the applications handle the volume settings. It is not recommended | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Jaroslav Kysela
						Jaroslav Kysela