Path: blob/main/documentation/manual-pages/ja/man3/cam.3
18093 views
.\"
.\" Copyright (c) 1998 Kenneth D. Merry.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" %FreeBSD: src/lib/libcam/cam.3,v 1.5.2.6 2001/12/17 10:08:28 ru Exp %
.\"
.\" $FreeBSD$
.Dd October 10, 1998
.Os
.Dt CAM 3
.Sh ̾��
.Nm cam_open_device ,
.Nm cam_open_spec_device ,
.Nm cam_open_btl ,
.Nm cam_open_pass ,
.Nm cam_close_device ,
.Nm cam_close_spec_device ,
.Nm cam_getccb ,
.Nm cam_send_ccb ,
.Nm cam_freeccb ,
.Nm cam_path_string ,
.Nm cam_device_dup ,
.Nm cam_device_copy ,
.Nm cam_get_device
.Nd CAM �桼���饤�֥��
.Sh �饤�֥��
.Lb libcam
.Sh ��
.In stdio.h
.In camlib.h
.Ft struct cam_device *
.Fo cam_open_device
.Fa "const char *path"
.Fa "int flags"
.Fc
.Ft struct cam_device *
.Fo cam_open_spec_device
.Fa "const char *dev_name"
.Fa "int unit"
.Fa "int flags"
.Fa "struct cam_device *device"
.Fc
.Ft struct cam_device *
.Fo cam_open_btl
.Fa "path_id_t path_id"
.Fa "target_id_t target_id"
.Fa "lun_id_t target_lun"
.Fa "int flags"
.Fa "struct cam_device *device"
.Fc
.Ft struct cam_device *
.Fo cam_open_pass
.Fa "const char *path"
.Fa "int flags"
.Fa "struct cam_device *device"
.Fc
.Ft void
.Fo cam_close_device
.Fa "struct cam_device *dev"
.Fc
.Ft void
.Fo cam_close_spec_device
.Fa "struct cam_device *dev"
.Fc
.Ft union ccb *
.Fo cam_getccb
.Fa "struct cam_device *dev"
.Fc
.Ft int
.Fo cam_send_ccb
.Fa "struct cam_device *device"
.Fa "union ccb *ccb"
.Fc
.Ft void
.Fo cam_freeccb
.Fa "union ccb *ccb"
.Fc
.Ft char *
.Fo cam_path_string
.Fa "struct cam_device *dev"
.Fa "char *str"
.Fa "int len"
.Fc
.Ft struct cam_device *
.Fo cam_device_dup
.Fa "struct cam_device *device"
.Fc
.Ft void
.Fo cam_device_copy
.Fa "struct cam_device *src"
.Fa "struct cam_device *dst"
.Fc
.Ft int
.Fo cam_get_device
.Fa "const char *path"
.Fa "char *dev_name"
.Fa "int devnamelen"
.Fa "int *unit"
.Fc
.Sh ����
CAM
�饤�֥��ϡ�
CAM
�����ƥ�ǤΥץ�����ߥ��������褦
�߷פ��줿�����Ĥ��δؿ��ǹ�������Ƥ��ޤ���
���Υޥ˥奢��ڡ����ϡ�
�饤�֥��ؿ��δ��ܥ��åȤˤĤ����������Ƥ���ޤ���
���˥ꥹ�Ȥ���
�ޥ˥奢��ڡ����ˤ����¿���δؿ������ܤ��Ƥ���ޤ���
.Pp
¿����
CAM
�饤�֥��ؿ���
.Va cam_device
��¤�Τ���Ѥ��ޤ���
.Bd -literal
struct cam_device {
char device_path[MAXPATHLEN+1];/*
* �桼�������ꤷ��
* �ǥХ����Υѥ�̾��
* �桼�����ǥХ���̾
* �ȥ�˥å��ֹ��
* �̡��˵��Ҥ����
* ����� NULL ��
* �ʤ뤳�Ȥ�����ޤ���
*/
char given_dev_name[DEV_IDLEN+1];/*
* �桼�������ꤷ��
* �ǥХ���̾��
*/
u_int32_t given_unit_number; /*
* �桼�������ꤷ��
* ��˥å��ֹ档
*/
char device_name[DEV_IDLEN+1];/*
* �ǥХ���̾��
* ���Ȥ��� 'pass'
*/
u_int32_t dev_unit_num; /* ��������ΥǥХ�����
* �б������̲�ǥХ�����
* ��˥å��ֹ档
*/
char sim_name[SIM_IDLEN+1];/*
* ����ȥ�����̾��
* ���Ȥ��� 'ahc'
*/
u_int32_t sim_unit_number; /* ����ȥ������˥å��ֹ� */
u_int32_t bus_id; /* ����ȥ�����Х��ֹ� */
lun_id_t target_lun; /* ������˥å��ֹ� */
target_id_t target_id; /* �������å� ID */
path_id_t path_id; /* �����ƥ� SCSI �Х��ֹ� */
u_int16_t pd_type; /* �������֤Υ����� */
struct scsi_inquiry_data inq_data; /* SCSI �Ȳ�ǡ��� */
u_int8_t serial_num[252]; /* �ǥХ������ꥢ���ֹ� */
u_int8_t serial_num_len; /* ���ꥢ���ֹ��Ĺ�� */
u_int8_t sync_period; /* Ĵ�����줿Ʊ������ */
u_int8_t sync_offset; /* Ĵ�����줿Ʊ�����ե��å� */
u_int8_t bus_width; /* Ĵ�����줿�Х��� */
int fd; /* �ǥХ����Υե����뵭�һ� */
};
.Ed
.Pp
.Fn cam_open_device
�ϡ������Ȥ��ơ��������Ȥ��Ƥ���ǥХ����Ҥ���ʸ����
�����
.Xr open 2
���Ϥ��Τ�Ŭ�ڤ�
.Ar flags
����ޤ���
�Ϥ����֥ѥ��פϡ�
�ºݤˤϡ������ǥХ���̾�ȥ�˥å��ֹ椬���ä�Ǥ�դΥ����פ�
ʸ����Ǥ���
ʸ�����
.Fn cam_get_device
�ˤ�äƲ�ᤵ��ơ�
�ǥХ���̾�ȥ�˥å��ֹ�ˤʤ�ޤ����ǥХ���̾�ȥ�˥å��ֹ椬
���ꤵ���ȡ���å����åפ��¹Ԥ���ơ�����ΥǥХ������б������̲�
�ǥХ�������ꤷ�ޤ���
.Fn cam_open_device
�ϻ���ˡ�Ϥ��ʤ��ñ�Ǥ�����
���¤ˤϰ���Ū�ʻ��Ѥ�Ŭ���Ƥ��ޤ���ư�ɬ������
����Ū�ǤϤʤ�����Ǥ������������ץꥱ��������������Ƥ���ץ�����ޤϡ�
�ʲ�����������¾�Υ����ץ�롼�����
1 �Ĥ���Ѥ���褦�ˤ��Ƥ���������
.Pp
.Fn cam_open_spec_device
�ϡ��Ϥ��줿�ǥХ���̾�ȥ�˥å��ֹ���б�����
.Xr pass 4
�ǥХ������ޤ���
.Ar flags
�ϡ�
.Xr open 2
���Ϥ��Τ�Ŭ�ڤʥե饰�Ǥ���
ɬ�פ�����ޤ���
.Ar device
�����ϥ��ץ����Ǥ���
�桼���ϡ�
.Va cam_device
��¤�Τ�
��꿶��Ѥߤζ��֤����Ǥ��ޤ���
.Ar device
������
.Va NULL
�ξ�硢
.Fn cam_open_spec_device
�ϡ�
.Xr malloc 3
����Ѥ���
.Va cam_device
��¤���Ѥζ��֤�
��꿶��ޤ���
.Pp
.Fn cam_open_btl
�ϡ�
.Fn cam_open_spec_device
��������Ƥ��ޤ����������Ȥ��ơ�
�ǥХ���̾�ȥ�˥å��ֹ�������
.Tn SCSI
�Х����������åȡ����������
��˥åȤ��������ۤʤ�ޤ���
.Va path_id
�����ϡ�
.Tn SCSI
�Х��ֹ��
CAM
��
Ʊ���Τ�ΤǤ�������ϥ����ƥ���������Х��ֹ��ɽ���ޤ���
.Ar flags
�ϡ�
.Xr open 2
���Ϥ��Τ�Ŭ�ڤʥե饰�Ǥ���ɬ�פ�����ޤ���
.Fn cam_open_spec_device
��Ʊ���褦�ˡ�
.Fa device
�����ϥ��ץ����Ǥ���
.Pp
.Fn cam_open_pass
�ϡ������Ȥ��ơ�����
.Xr pass 4
�ǥХ�����
.Fa path
����ޤ���
�Ѵ����å����åפ�Ԥ��ʤ��Τǡ�
�Ϥ����ѥ��� CAM
.Xr pass 4
�ǥХ�����
�ѥ��Ǥʤ���Фʤ�ޤ���
.Fa flags
�ϡ�
.Xr open 2
���Ϥ��Τ�Ŭ�����ե饰�Ǥ���
ɬ�פ�����ޤ���
.Fa device
�����ϡ��桼����
CAM
�饤�֥���
.Va cam_device
��¤���Ѥζ��֤��꿶�ꤵ���������ϡ�
.Fn cam_open_spec_device
�����
.Fn cam_open_btl
��Ʊ���褦�ˡ�
NULL
�Ǥ���ɬ�פ�����ޤ���
.Fn cam_close_device
�ϡ��嵭�� open() �ƤӽФ���
1 �Ĥ���꿶�ä�
.Va cam_device
��¤�Τ���������̲�ǥХ����ؤΥե����뵭�һҤ��Ĥ��ޤ���
�桼����
.Va cam_device
��¤���Ѥζ��֤��꿶�äƤ�����ϡ����Υ롼�����Ƥ�
�Ф��ƤϤʤ�ޤ���
����ˡ��桼����
.Fn cam_close_spec_device
��ƤӽФ��٤��Ǥ���
.Pp
.Fn cam_close_spec_device
�ϡ��嵭�� open() �롼�����
1 �Ĥdz����줿
�ե����뵭�һҤ��Ĥ�������Ǥ������δؿ��ϡ�
.Va cam_device
��
CAM
�饤�֥��
�ǤϤʤ����ƤӽФ����ˤ�äƳ�꿶��줿�Ȥ��˸ƤӽФ�ɬ�פ�����ޤ���
.Pp
.Fn cam_getccb
�ϡ�
.Xr malloc 3
����Ѥ���
CCB
���꿶�ꡢ
.Va cam_device
��¤���ͤ���Ѥ���
CCB
�إå���˥ե�����ɤ����ꤷ�ޤ���
.Pp
.Fn cam_send_ccb
�ϡ������
.Va ccb
��
.Va cam_device
��¤����ǵ��Ҥ��줿
.Fa device
��
�������ޤ���
.Pp
.Fn cam_freeccb
�ϡ�
.Fn cam_getccb
����꿶�ä�
CCB
��������ޤ���
.Pp
.Fn cam_path_string
�ϡ������Ȥ��ơ�
.Va cam_device
��¤�Ρ������Ĺ����
.Fa len
�Υ��ȥ����ޤ���
���δؿ��ϡ������ͥ뤬���Ѥ���Τ�����������������
��λ���������Ƭ�쥹�ȥ��������ޤ���
���Ȥ��С�"(cd0:ahc1:0:4:0): " �Ǥ���
.Fn cam_path_string
�ϡ�¿���Ȥ�
.Fa len Ns \-1
����饯����
.Ar str
�����ꤷ�ޤ���
.Fa len
�֤�Υ���饯���ϡ���λ��
.Ql \e0
�Ǥ���
.Pp
.Fn cam_device_dup
�ϡ�
.Xr strdup 3
��Ʊ���褦����ˡ��ư��ޤ���
.Va cam_device
��¤���Ѥ˶��֤������ơ��Ϥ��줿
.Fa device
��¤�Τ����Ƥ����˳�꿶��줿
��¤�Τ˥��ԡ����ޤ���
.Pp
.Fn cam_device_copy
��
.Fa src
��¤�Τ�
.Fa dst
�˥��ԡ����ޤ���
.Pp
.Fn cam_get_device
�ϡ��ǥХ���̾�˥�˥å��ֹ椬³�������ȥ�����ä�
.Fa path
��������ޤ������ˡ����ȥ��ǥХ���̾�ȥ�˥å�̾��ʬ��
���줾��
.Fa dev_name
��
.Fa unit
���ᤷ�ޤ���
.Fn cam_get_device
�ϡ����ʤ��Ȥ⼡��
�����Υ��ȥ������Ǥ��ޤ���
.Pp
.Bl -tag -width 1234 -compact
.It /dev/foo0a
.It /dev/foo1s2c
.It foo0
.It foo0a
.It nfoo0
.El
.Pp
.Fn cam_get_device
�ϡ�
.Fn cam_open_device
�����������ǽ���������ɬ�פ�����
���ץꥱ��������Ѥ������ʴؿ��Ȥ����������Ƥ��ޤ����ץ�����ޤϡ�
��ǽ�Ǥ���С��ǥХ���̾�ȥ�˥å��ֹ�������äȷ���Ū��������
���Ѥ��뤳�Ȥ��ᤷ�ޤ���
.Sh �����
.Fn cam_open_device
��
.Fn cam_open_spec_device
��
.Fn cam_open_btl
�������
.Fn cam_open_pass
�ϡ�
.Va cam_device
��¤��ؤ��ݥ����֤��ޤ����ޤ��ϡ�
���顼�����ä�����
NULL
���֤��ޤ���
.Pp
.Fn cam_getccb
�ϡ���꿶��Ѥߤ���ʬŪ�˽�����Ѥߤ�
CCB
���֤��ޤ����ޤ���
CCB
�γ�꿶�꤬�������Ԥ�������
NULL
���֤��ޤ���
.Pp
.Fn cam_send_ccb
�ϡ����顼��ȯ��������硢�� -1 ���֤���
.Va errno
�����顼��
�����褦�����ꤵ��ޤ���
.Pp
.Fn cam_path_string
�ϡ��ص��Ȥ��Ƶ������줿������Ƭ����֤��ޤ�������ϡ�
.Fn cam_path_string
���Ϥ����Τ�Ʊ��
.Fa str
�Ǥ���
.Pp
.Fn cam_device_dup
�ϡ��Ϥ��줿
.Va device
�Υ��ԡ����֤��ޤ����ޤ��ϡ����顼��
ȯ����������
NULL
���֤��ޤ���
.Pp
.Fn cam_get_device
�ϡ����������ξ��� 0 ���֤���
�������Ԥ����� -1 ���֤��ޤ���
.Pp
������������������ CAM �饤�֥��ؿ��� 1 �Ĥ���
���顼���֤��줿���ϡ�
���顼����ͳ�����̤˥������Х륹�ȥ��
.Va cam_errbuf
�˰�������ޤ���
���������
.Dv CAM_ERRBUF_SIZE
����饯���Ǥ���
.Sh ��Ϣ����
.Xr cam_cdbparse 3 ,
.Xr pass 4 ,
.Xr camcontrol 8
.Pp
.Sh ���
CAM �饤�֥���
.Fx 3.0
�ǤϤ�����о줷�ޤ�����
.Sh ���
.An Kenneth Merry Aq [email protected]
.Sh �Х�
.Fn cam_open_device
�ϡ��Ϥ��줿
.Fa path
�������ؤ�
symlink
�Ǥ��뤫�ɤ���
�����å����ޤ����Ϥ��줿
.Fa path
���ºݤ�
.Xr pass 4
�ǥХ����Ǥ��뤫�ɤ�����
�����å����ޤ������Υ����å���¸�����ΤϤ��ʤ��ñ�Ǥ��礦�������
�����å���¹Ԥ��뤿��ˤϡ�
.Xr pass 4
�ǥХ����Ȥ��ƥǥХ����Ρ��ɤ��̤���
����Ū����ˡ��ɬ�פǤ��礦��
.Pp
�����餯�ؿ��ˤ�̾������Ŭ�ڤʤ�Τ䡢̾�����Խ�ʬ�ʤ�Τ�����ޤ���