drive definitions for HP85 disk emulator project for AVR. More...

#include "user_config.h"
#include <stdint.h>
#include "defines.h"
#include "drives.h"
#include "gpib_hal.h"
#include "gpib.h"
#include "gpib_task.h"
#include "amigo.h"
#include "ss80.h"
#include <time.h>
#include "lifutils.h"
#include "debug.h"

Macros
#define	MAX_STACK 5
	Config Parser Stack. More...

Functions
void	print_var_P (__memx const char *str, uint32_t val)
	Display Configuration File variable. More...

void	print_str_P (__memx const char str, char arg)
	Display Configuration File string. More...

int8_t	tok_index (char *str)
	return the tokens index of the matching string More...

char *	tok_name (uint8_t tok)
	return string of matching token More...

void	print_tok_val (uint8_t tok, uint8_t spaces, uint32_t val)
	Display Configuration File variable. More...

void	print_tok_str (uint8_t tok, uint8_t spaces, char *str)
	Display Configuration File variable. More...

void	print_tok (uint8_t tok, uint8_t spaces)
	Display Configuration File variable. More...

int	Read_Config (char *name)
	Read and parse a config file using POSIX functions Set all drive parameters and debuglevel. More...

void	display_Addresses (int verbose)
	Display Configuration device address saummary. More...

void	display_Config (int verbose)
	Display current Configuration File values. More...

int8_t	find_type (int type)
	Seach Devices[] for ANY definitions of a disk type. More...

int8_t	count_drive_types (uint8_t type)
	Count number of devices of a sertain type. More...

char *	type_to_str (int type)
	Convert a disk type into a string. More...

char *	base_to_str (int base)
	Convert base address into a string identifier. More...

int8_t	find_free ()
	Find first free Devices[] slot. More...

int8_t	find_device (int type, int address, int base)
	Find a device with matching type AND address. More...

int8_t	set_active_device (int8_t index)
	Set the Active disk or device pointers Since we can be called multiple times per single GPIB state we do not display state changes here. Other code displays the active state. More...

void	SS80_Set_Defaults (int8_t index)
	Set Default Values for a new SS80 Device IF defaults have been defined Most values in the CONTROLER and UNIT are defaults that should not need to be specified Note all of the values are zeroed on allocation including strings. More...

void	free_device (int8_t index)
	Free a Device structure for a disk or printer. More...

int8_t	alloc_device (int type)
	Allocate a Device structure for a disk or printer. More...

void	init_Devices ()
	Init Config Parser Stack Called only durring power up so we do not have to free memory. More...

int	push_state (int state)
	Push Parser State. More...

int	pop_state ()
	Pop Parser State. More...

bool	assign_value (char str, uint32_t minval, uint32_t maxval, uint32_t val)
	assigned a value More...

void	set_Config_Defaults ()
	Set Defaults for any missing disk or printer devices These are only used if the Config file omits them or is empty. More...

int8_t	hpdir_set_device (int8_t index)
	Set Device parameters from hpdir information. More...

int8_t	hpdir_set_parameters (int8_t index, char *model)
	Lookup model in and set drive parameters if found. More...

int8_t	verify_device (int8_t index)
	Verify a device and delete it is there are any errors. More...

void	verify_devices ()
	Post process and Verify all devices. More...

void	format_drives ()
	Format devices that have no image file. More...

void	drives_help (int8_t full)
	Help Menu for drives and configuration help See: int drives_tests(char *str) More...

void	mount_usage ()

int	drives_tests (int argc, char *argv[])
	GPIB user tests User invoked GPIB functions and tasks. More...

int8_t	index_address (int8_t address)
	return index matching address More...

int8_t	test_address (int8_t address)
	test if address is in use More...

int8_t	index_ppr (int8_t ppr)
	return index matching ppr More...

int8_t	test_ppr (int8_t ppr)
	test if PPR is in use More...

int8_t	umount (int argc, char *argv[])
	umount disks - testing More...

int8_t	mount (int argc, char *argv[])
	mount disks - testing More...

void	display_mount (int8_t index)

void	display_mounts ()

Variables
hpdir_t	hpdir
	hpdir.ini file processing More...

static int	stack_ind = 0

static int	stack_p [MAX_STACK]

DeviceType	Devices [MAX_DEVICES]

PRINTERDeviceType *	PRINTERp = NULL
	Active Printer Device. More...

SS80DiskType *	SS80p = NULL
	Active SS80 Device. More...

SS80StateType *	SS80s = NULL

token_t	tokens []

int	lines = 0
	Config file line number. More...

Detailed Description

drive definitions for HP85 disk emulator project for AVR.

Edit History

[1.0] [Mike Gore] Initial revision of file.

Copyright © 2014-2020 Mike Gore, All rights reserved. GPL

See also: http://github.com/magore/hp85disk; http://github.com/magore/hp85disk/COPYRIGHT.md for Copyright details

Definition in file drives.c.

Macro Definition Documentation

◆ MAX_STACK

#define MAX_STACK 5

Config Parser Stack.

Definition at line 28 of file drives.c.

Function Documentation

◆ alloc_device()

int8_t alloc_device ( int type )

Allocate a Device structure for a disk or printer.

Parameters

type disk type

Returns: Devices[] index on sucess or -1

Definition at line 1269 of file drives.c.

Referenced by mount(), and Read_Config().

◆ assign_value()

bool assign_value	(	char *	str,
		uint32_t	minval,
		uint32_t	maxval,
		uint32_t *	val
	)

assigned a value

===============================================

Used only for debugging
Parameters

[in] str string to examine

[in] minval minimum value

[in] maxval maximum value

[in] *val value to set

Returns
1 is matched and value in range, 0 not matched or out of range

Definition at line 1380 of file drives.c.

◆ base_to_str()

char* base_to_str ( int base )

Convert base address into a string identifier.

Parameters

base	BASE_MAL, BASE_MTA or BASE_MSA only

Returns: string "MLA", "MTA", "MSA" or error string

Definition at line 1038 of file drives.c.

◆ count_drive_types()

int8_t count_drive_types ( uint8_t type )

Count number of devices of a sertain type.

Parameters

type	disk type like SS80_TYPE

Definition at line 1005 of file drives.c.

◆ display_Addresses()

void display_Addresses ( int verbose )

Display Configuration device address saummary.

===============================================

Returns: void

Definition at line 778 of file drives.c.

Referenced by drives_tests(), and main().

◆ display_Config()

void display_Config ( int verbose )

Display current Configuration File values.

===============================================

Returns: void

Active Printer Device

Active SS80 Device

Definition at line 849 of file drives.c.

Referenced by drives_tests().

◆ display_mount()

void display_mount ( int8_t index )

Active Printer Device

Active SS80 Device

Definition at line 2064 of file drives.c.

Referenced by display_mounts(), and verify_device().

◆ display_mounts()

void display_mounts ( )

Definition at line 2102 of file drives.c.

Referenced by mount().

◆ drives_help()

void drives_help ( int8_t full )

Help Menu for drives and configuration help See: int drives_tests(char *str)

Returns: void

Definition at line 1760 of file drives.c.

Referenced by drives_tests(), help(), and mount_usage().

◆ drives_tests()

int drives_tests	(	int	argc,
		char *	argv[]
	)

GPIB user tests User invoked GPIB functions and tasks.

Returns: 1 matched token, 0 if not

Definition at line 1798 of file drives.c.

Referenced by user_task().

◆ find_device()

int8_t find_device	(	int	type,
		int	address,
		int	base
	)

Find a device with matching type AND address.

Parameters

type	disk type
address	GPIB device address 0 based
base	BASE_MLA,BASE_MTA or BASE_MSA address range

Returns: index of Devices[] or -1 if not found

Make sure address is in expected range

convert to device address

search for device address

Definition at line 1063 of file drives.c.

Referenced by listen_cleanup(), PRINTER_is_MLA(), PRINTER_is_MSA(), PRINTER_is_MTA(), SS80_is_MLA(), SS80_is_MSA(), and SS80_is_MTA().

◆ find_free()

int8_t find_free ( )

Find first free Devices[] slot.

Returns: Devices[] index of free slot or -1

Definition at line 1052 of file drives.c.

Referenced by alloc_device(), and set_Config_Defaults().

◆ find_type()

int8_t find_type ( int type )

Seach Devices[] for ANY definitions of a disk type.

Parameters

type	disk type like SS80_TYPE

Definition at line 991 of file drives.c.

Referenced by find_free(), set_Config_Defaults(), and SS80_Set_Defaults().

◆ format_drives()

void format_drives ( )

Format devices that have no image file.

===============================================

Returns: void

Active SS80 Device

Definition at line 1669 of file drives.c.

Referenced by main().

◆ free_device()

void free_device ( int8_t index )

Free a Device structure for a disk or printer.

Parameters

type	disk index

Returns: void

Definition at line 1220 of file drives.c.

Referenced by umount(), and verify_device().

◆ hpdir_set_device()

int8_t hpdir_set_device ( int8_t index )

Set Device parameters from hpdir information.

===============================================

Parameters

[in] index device index

Returns: 1 success, 0 on error

Definition at line 1495 of file drives.c.

Referenced by hpdir_set_parameters().

◆ hpdir_set_parameters()

int8_t hpdir_set_parameters	(	int8_t	index,
		char *	model
	)

Lookup model in and set drive parameters if found.

===============================================

Parameters

[in]	index	Devices index
[in]	model	model string

Returns: 1 on success, 0 or failure

Definition at line 1541 of file drives.c.

Referenced by mount(), and Read_Config().

◆ index_address()

int8_t index_address ( int8_t address )

return index matching address

Returns: index or -1 if not found

Definition at line 1862 of file drives.c.

Referenced by test_address(), and umount().

◆ index_ppr()

int8_t index_ppr ( int8_t ppr )

return index matching ppr

Returns: index or -1 if not found

Definition at line 1892 of file drives.c.

Referenced by test_ppr().

◆ init_Devices()

void init_Devices ( )

Init Config Parser Stack Called only durring power up so we do not have to free memory.

Definition at line 1325 of file drives.c.

Referenced by Read_Config().

◆ mount()

int8_t mount	(	int	argc,
		char *	argv[]
	)

mount disks - testing

===============================================

Returns: Devices[] index on success, -1 on error

Active Printer Device

Active SS80 Device

Definition at line 1948 of file drives.c.

Referenced by drives_tests().

◆ mount_usage()

void mount_usage ( )

Definition at line 1789 of file drives.c.

Referenced by mount().

◆ pop_state()

int pop_state ( )

Pop Parser State.

===============================================

Returns: state

Definition at line 1358 of file drives.c.

Referenced by Read_Config().

◆ print_str_P()

void print_str_P	(	__memx const char *	str,
		char *	arg
	)

Display Configuration File string.

===============================================

Parameters

*str	title
*arg	string

Returns: void

Definition at line 241 of file drives.c.

◆ print_tok()

void print_tok	(	uint8_t	tok,
		uint8_t	spaces
	)

Display Configuration File variable.

===============================================

@brief Display Configuration File variable

Parameters

str	title
spaces	indent

Returns: void

Definition at line 321 of file drives.c.

Referenced by display_Config().

◆ print_tok_str()

void print_tok_str	(	uint8_t	tok,
		uint8_t	spaces,
		char *	str
	)

Display Configuration File variable.

===============================================

Parameters

tok	token
spaces	indent
str	string

Returns: void

Definition at line 305 of file drives.c.

Referenced by display_Addresses(), and display_Config().

◆ print_tok_val()

void print_tok_val	(	uint8_t	tok,
		uint8_t	spaces,
		uint32_t	val
	)

Display Configuration File variable.

===============================================

Parameters

tok	token
spaces	indent
val	variable value

Returns: void

Definition at line 290 of file drives.c.

Referenced by display_Addresses(), and display_Config().

◆ print_var_P()

void print_var_P	(	__memx const char *	str,
		uint32_t	val
	)

Display Configuration File variable.

===============================================

Parameters

str	title
val	variable value

Returns: void

Definition at line 224 of file drives.c.

◆ push_state()

int push_state ( int state )

Push Parser State.

===============================================

Parameters

state parser state

Returns: state

Definition at line 1345 of file drives.c.

Referenced by Read_Config().

◆ Read_Config()

int Read_Config ( char * name )

Read and parse a config file using POSIX functions Set all drive parameters and debuglevel.

===============================================

Parameters

name	config file name to process

Returns: number of parse errors

Printer Device

SS80 Device

Definition at line 336 of file drives.c.

Referenced by gpib_file_init().

◆ set_active_device()

int8_t set_active_device ( int8_t index )

Set the Active disk or device pointers Since we can be called multiple times per single GPIB state we do not display state changes here. Other code displays the active state.

Parameters

index Devices[] index

Returns: 1 on success or 0 on fail

We also check for -1 So the result of find_device() can be used without additional tests

Definition at line 1093 of file drives.c.

Referenced by PRINTER_is_MLA(), PRINTER_is_MSA(), PRINTER_is_MTA(), SS80_init(), SS80_is_MLA(), SS80_is_MSA(), and SS80_is_MTA().

◆ set_Config_Defaults()

void set_Config_Defaults ( )

Set Defaults for any missing disk or printer devices These are only used if the Config file omits them or is empty.

===============================================

Returns: void

Definition at line 1427 of file drives.c.

Referenced by gpib_file_init(), and Read_Config().

◆ SS80_Set_Defaults()

void SS80_Set_Defaults ( int8_t index )

Set Default Values for a new SS80 Device IF defaults have been defined Most values in the CONTROLER and UNIT are defaults that should not need to be specified Note all of the values are zeroed on allocation including strings.

Returns: void

Definition at line 1177 of file drives.c.

Referenced by alloc_device().

◆ test_address()

int8_t test_address ( int8_t address )

test if address is in use

Returns: index 1 if found, 0 if not

Definition at line 1875 of file drives.c.

◆ test_ppr()

int8_t test_ppr ( int8_t ppr )

test if PPR is in use

Returns: index 1 if found, 0 if not

Definition at line 1905 of file drives.c.

◆ tok_index()

int8_t tok_index ( char * str )

return the tokens index of the matching string

===============================================

Parameters

str	string tro match

Returns: index

Definition at line 256 of file drives.c.

Referenced by Read_Config().

◆ tok_name()

char* tok_name ( uint8_t tok )

return string of matching token

===============================================

Parameters

tok token

Returns: char *ptr;

Definition at line 272 of file drives.c.

Referenced by print_tok(), print_tok_str(), and print_tok_val().

◆ type_to_str()

char* type_to_str ( int type )

Convert a disk type into a string.

Parameters

type	disk type like SS80_TYPE

Returns: string pointer

Definition at line 1021 of file drives.c.

Referenced by alloc_device(), and set_active_device().

◆ umount()

int8_t umount	(	int	argc,
		char *	argv[]
	)

umount disks - testing

===============================================

Returns: Devices[] index on success, -1 on error

Definition at line 1922 of file drives.c.

Referenced by drives_tests().

◆ verify_device()

int8_t verify_device ( int8_t index )

Verify a device and delete it is there are any errors.

===============================================

Returns: 1 = OK 0 = ERROR

Active SS80 Device

Definition at line 1552 of file drives.c.

Referenced by mount(), and verify_devices().

◆ verify_devices()

void verify_devices ( )

Post process and Verify all devices.

===============================================

Returns: 1 = OK 0 = ERROR

Definition at line 1655 of file drives.c.

Referenced by Read_Config().

Variable Documentation

◆ Devices

DeviceType Devices[MAX_DEVICES]

Definition at line 32 of file drives.c.

Referenced by alloc_device(), count_drive_types(), display_Addresses(), display_Config(), display_mount(), find_device(), find_type(), format_drives(), free_device(), hpdir_set_device(), index_address(), index_ppr(), init_Devices(), mount(), Read_Config(), set_active_device(), set_Config_Defaults(), SS80_init(), SS80_Set_Defaults(), and verify_device().

◆ hpdir

hpdir_t hpdir

hpdir.ini file processing

Definition at line 48 of file drives.c.

Referenced by hpdir_set_device(), and mount().

◆ lines

int lines = 0

Config file line number.

Definition at line 1368 of file drives.c.

Referenced by assign_value(), MatRead(), and Read_Config().

◆ PRINTERp

PRINTERDeviceType* PRINTERp = NULL

Active Printer Device.

Definition at line 35 of file drives.c.

Referenced by display_Config(), display_mount(), mount(), Read_Config(), and set_active_device().

◆ SS80p

◆ SS80s

SS80StateType* SS80s = NULL

Definition at line 39 of file drives.c.

Referenced by Clear_Common(), GPIB(), set_active_device(), SS80_Cancel(), SS80_Check_Unit(), SS80_Check_Volume(), SS80_cmd_seek(), SS80_Command_State(), SS80_error_return(), SS80_Execute_State(), SS80_increment(), SS80_init(), SS80_locate_and_read(), SS80_locate_and_write(), SS80_Report(), SS80_send_status(), and SS80_Transparent_State().

◆ stack_ind

int stack_ind = 0

static

Definition at line 29 of file drives.c.

Referenced by init_Devices(), pop_state(), and push_state().

◆ stack_p

int stack_p[MAX_STACK]

static

Definition at line 30 of file drives.c.

Referenced by pop_state(), and push_state().

◆ tokens

token_t tokens[]

Definition at line 169 of file drives.c.

Referenced by Read_Config(), tok_index(), and tok_name().

[in]	str	string to examine
[in]	minval	minimum value
[in]	maxval	maximum value
[in]	*val	value to set

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_STACK

Function Documentation

◆ alloc_device()

◆ assign_value()

◆ base_to_str()

◆ count_drive_types()

◆ display_Addresses()

◆ display_Config()

◆ display_mount()

◆ display_mounts()

◆ drives_help()

◆ drives_tests()

◆ find_device()

◆ find_free()

◆ find_type()

◆ format_drives()

◆ free_device()

◆ hpdir_set_device()

◆ hpdir_set_parameters()

◆ index_address()

◆ index_ppr()

◆ init_Devices()

◆ mount()

◆ mount_usage()

◆ pop_state()

◆ print_str_P()

◆ print_tok()

@brief Display Configuration File variable

◆ print_tok_str()

◆ print_tok_val()

◆ print_var_P()

◆ push_state()

◆ Read_Config()

◆ set_active_device()

◆ set_Config_Defaults()

◆ SS80_Set_Defaults()

◆ test_address()

◆ test_ppr()

◆ tok_index()

◆ tok_name()

◆ type_to_str()

◆ umount()

◆ verify_device()

◆ verify_devices()

Variable Documentation

◆ Devices

◆ hpdir

◆ lines

◆ PRINTERp

◆ SS80p

◆ SS80s

◆ stack_ind

◆ stack_p

◆ tokens